WordPress.org

Make WordPress Core

Changeset 28909


Ignore:
Timestamp:
06/29/2014 10:33:46 PM (6 years ago)
Author:
DrewAPicture
Message:

Convert documentation of default arguments in wp_list_authors() to the hash-notation style.

Props Viper007Bond.
Fixes #28684.

File:
1 edited

Legend:

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

    r28392 r28909  
    305305 * List all the authors of the blog, with several options available.
    306306 *
    307  * <ul>
    308  * <li>optioncount (boolean) (false): Show the count in parenthesis next to the
    309  * author's name.</li>
    310  * <li>exclude_admin (boolean) (true): Exclude the 'admin' user that is
    311  * installed by default.</li>
    312  * <li>show_fullname (boolean) (false): Show their full names.</li>
    313  * <li>hide_empty (boolean) (true): Don't show authors without any posts.</li>
    314  * <li>feed (string) (''): If isn't empty, show links to author's feeds.</li>
    315  * <li>feed_image (string) (''): If isn't empty, use this image to link to
    316  * feeds.</li>
    317  * <li>echo (boolean) (true): Set to false to return the output, instead of
    318  * echoing.</li>
    319  * <li>style (string) ('list'): Whether to display list of authors in list form
    320  * or as a string.</li>
    321  * <li>html (bool) (true): Whether to list the items in html form or plaintext.
    322  * </li>
    323  * <li>exclude (array): Array of user IDs to explicitly exclude.</li>
    324  * <li>include (array): Array of user IDs to explicitly include.</li>
    325  * </ul>
    326  *
    327307 * @link http://codex.wordpress.org/Template_Tags/wp_list_authors
     308 *
    328309 * @since 1.2.0
    329  * @param array $args The argument array.
    330  * @return null|string The output, if echo is set to false.
     310 *
     311 * @param string|array $args {
     312 *     Optional. Array or string of default arguments.
     313 *
     314 *     @type string $orderby       How to sort the authors. Accepts 'nicename', 'email', 'url', 'registered',
     315 *                                 'user_nicename', 'user_email', 'user_url', 'user_registered', 'name',
     316 *                                 'display_name', 'post_count', 'ID', 'meta_value', 'user_login'. Default 'name'.
     317 *     @type string $order         Sorting direction for $orderby. Accepts 'ASC', 'DESC'. Default 'ASC'.
     318 *     @type int    $number        Maximum authors to return or display. Default empty (all authors).
     319 *     @type bool   $optioncount   Show the count in parenthesis next to the author's name. Default false.
     320 *     @type bool   $exclude_admin Whether to exclude the 'admin' account, if it exists. Default false.
     321 *     @type bool   $show_fullname Whether to show the author's full name. Default false.
     322 *     @type bool   $hide_empty    Whether to hide any authors with no posts. Default true.
     323 *     @type string $feed          If not empty, show a link to the author's feed and use this text as the alt
     324 *                                 parameter of the link. Default empty.
     325 *     @type string $feed_image    If not empty, show a link to the author's feed and use this image URL as
     326 *                                 clickable anchor. Default empty.
     327 *     @type string $feed_type     The feed type to link to, such as 'rss2'. Defaults to default feed type.
     328 *     @type bool   $echo          Whether to output the result or instead return it. Default true.
     329 *     @type string $style         If 'list', each author is wrapped in an `<li>` element, otherwise the authors
     330 *                                 will be separated by commas.
     331 *     @type bool   $html          Whether to list the items in HTML form or plaintext. Default true.
     332 *     @type string $exclude       An array, comma-, or space-separated list of author IDs to exclude. Default empty.
     333 *     @type string $exclude       An array, comma-, or space-separated list of author IDs to include. Default empty.
     334 * }
     335 * @return null|string The output, if echo is set to false. Otherwise null.
    331336 */
    332337function wp_list_authors( $args = '' ) {
Note: See TracChangeset for help on using the changeset viewer.