WordPress.org

Make WordPress Core


Ignore:
Timestamp:
07/04/2016 02:33:03 PM (3 years ago)
Author:
SergeyBiryukov
Message:

Docs: In wp_list_authors(), clarify that include and exclude arguments can also be an array.

Fix duplicated exclude argument description.

Props birgire.
Fixes #37239.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/author-template.php

    r37495 r37949  
    338338 *     Optional. Array or string of default arguments.
    339339 *
    340  *     @type string $orderby       How to sort the authors. Accepts 'nicename', 'email', 'url', 'registered',
    341  *                                 'user_nicename', 'user_email', 'user_url', 'user_registered', 'name',
    342  *                                 'display_name', 'post_count', 'ID', 'meta_value', 'user_login'. Default 'name'.
    343  *     @type string $order         Sorting direction for $orderby. Accepts 'ASC', 'DESC'. Default 'ASC'.
    344  *     @type int    $number        Maximum authors to return or display. Default empty (all authors).
    345  *     @type bool   $optioncount   Show the count in parenthesis next to the author's name. Default false.
    346  *     @type bool   $exclude_admin Whether to exclude the 'admin' account, if it exists. Default false.
    347  *     @type bool   $show_fullname Whether to show the author's full name. Default false.
    348  *     @type bool   $hide_empty    Whether to hide any authors with no posts. Default true.
    349  *     @type string $feed          If not empty, show a link to the author's feed and use this text as the alt
    350  *                                 parameter of the link. Default empty.
    351  *     @type string $feed_image    If not empty, show a link to the author's feed and use this image URL as
    352  *                                 clickable anchor. Default empty.
    353  *     @type string $feed_type     The feed type to link to, such as 'rss2'. Defaults to default feed type.
    354  *     @type bool   $echo          Whether to output the result or instead return it. Default true.
    355  *     @type string $style         If 'list', each author is wrapped in an `<li>` element, otherwise the authors
    356  *                                 will be separated by commas.
    357  *     @type bool   $html          Whether to list the items in HTML form or plaintext. Default true.
    358  *     @type string $exclude       An array, comma-, or space-separated list of author IDs to exclude. Default empty.
    359  *     @type string $exclude       An array, comma-, or space-separated list of author IDs to include. Default empty.
     340 *     @type string       $orderby       How to sort the authors. Accepts 'nicename', 'email', 'url', 'registered',
     341 *                                       'user_nicename', 'user_email', 'user_url', 'user_registered', 'name',
     342 *                                       'display_name', 'post_count', 'ID', 'meta_value', 'user_login'. Default 'name'.
     343 *     @type string       $order         Sorting direction for $orderby. Accepts 'ASC', 'DESC'. Default 'ASC'.
     344 *     @type int          $number        Maximum authors to return or display. Default empty (all authors).
     345 *     @type bool         $optioncount   Show the count in parenthesis next to the author's name. Default false.
     346 *     @type bool         $exclude_admin Whether to exclude the 'admin' account, if it exists. Default false.
     347 *     @type bool         $show_fullname Whether to show the author's full name. Default false.
     348 *     @type bool         $hide_empty    Whether to hide any authors with no posts. Default true.
     349 *     @type string       $feed          If not empty, show a link to the author's feed and use this text as the alt
     350 *                                       parameter of the link. Default empty.
     351 *     @type string       $feed_image    If not empty, show a link to the author's feed and use this image URL as
     352 *                                       clickable anchor. Default empty.
     353 *     @type string       $feed_type     The feed type to link to, such as 'rss2'. Defaults to default feed type.
     354 *     @type bool         $echo          Whether to output the result or instead return it. Default true.
     355 *     @type string       $style         If 'list', each author is wrapped in an `<li>` element, otherwise the authors
     356 *                                       will be separated by commas.
     357 *     @type bool         $html          Whether to list the items in HTML form or plaintext. Default true.
     358 *     @type array|string $exclude       Array or comma/space-separated list of author IDs to exclude. Default empty.
     359 *     @type array|string $include       Array or comma/space-separated list of author IDs to include. Default empty.
    360360 * }
    361361 * @return string|void The output, if echo is set to false.
Note: See TracChangeset for help on using the changeset viewer.