Docs: Reorder argument descriptions in the DocBlock for `wp_list_categories()` to match the default arguments list and improve reading at a glance.

Props birgire for the initial patch.
Fixes #36693.

Built from https://develop.svn.wordpress.org/trunk@37571


git-svn-id: http://core.svn.wordpress.org/trunk@37539 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2016-05-25 19:40:27 +00:00
parent da72b04ab2
commit b9ed1cb665
2 changed files with 27 additions and 27 deletions

View File

@ -500,44 +500,44 @@ function wp_dropdown_categories( $args = '' ) {
* @param string|array $args {
* Array of optional arguments.
*
* @type string $show_option_all Text to display for showing all categories. Default empty string.
* @type string $show_option_none Text to display for the 'no categories' option.
* Default 'No categories'.
* @type string $orderby The column to use for ordering categories. Default 'ID'.
* @type string $order Which direction to order categories. Accepts 'ASC' or 'DESC'.
* Default 'ASC'.
* @type bool|int $show_count Whether to show how many posts are in the category. Default 0.
* @type bool|int $hide_empty Whether to hide categories that don't have any posts attached to them.
* Default 1.
* @type bool|int $use_desc_for_title Whether to use the category description as the title attribute.
* Default 1.
* @type string $feed Text to use for the feed link. Default 'Feed for all posts filed
* under [cat name]'.
* @type string $feed_type Feed type. Used to build feed link. See get_term_feed_link().
* Default empty string (default feed).
* @type string $feed_image URL of an image to use for the feed link. Default empty string.
* @type int $child_of Term ID to retrieve child terms of. See get_terms(). Default 0.
* @type int|array $current_category ID of category, or array of IDs of categories, that should get the
* 'current-cat' class. Default 0.
* @type int $depth Category depth. Used for tab indentation. Default 0.
* @type bool|int $echo True to echo markup, false to return it. Default 1.
* @type array|string $exclude Array or comma/space-separated string of term IDs to exclude.
* If `$hierarchical` is true, descendants of `$exclude` terms will also
* be excluded; see `$exclude_tree`. See get_terms().
* Default empty string.
* @type array|string $exclude_tree Array or comma/space-separated string of term IDs to exclude, along
* with their descendants. See get_terms(). Default empty string.
* @type bool|int $echo True to echo markup, false to return it. Default 1.
* @type int|array $current_category ID of category, or array of IDs of categories, that should get the
* 'current-cat' class. Default 0.
* @type bool $hierarchical Whether to include terms that have non-empty descendants.
* See get_terms(). Default true.
* @type string $title_li Text to use for the list title `<li>` element. Pass an empty string
* to disable. Default 'Categories'.
* @type string $feed Text to use for the feed link. Default 'Feed for all posts filed
* under [cat name]'.
* @type string $feed_image URL of an image to use for the feed link. Default empty string.
* @type string $feed_type Feed type. Used to build feed link. See get_term_feed_link().
* Default empty string (default feed).
* @type bool|int $hide_empty Whether to hide categories that don't have any posts attached to them.
* Default 1.
* @type bool $hide_title_if_empty Whether to hide the `$title_li` element if there are no terms in
* the list. Default false (title will always be shown).
* @type int $depth Category depth. Used for tab indentation. Default 0.
* @type string $taxonomy Taxonomy name. Default 'category'.
* @type bool $hierarchical Whether to include terms that have non-empty descendants.
* See get_terms(). Default true.
* @type string $order Which direction to order categories. Accepts 'ASC' or 'DESC'.
* Default 'ASC'.
* @type string $orderby The column to use for ordering categories. Default 'ID'.
* @type string $separator Separator between links. Default '<br />'.
* @type bool|int $show_count Whether to show how many posts are in the category. Default 0.
* @type string $show_option_all Text to display for showing all categories. Default empty string.
* @type string $show_option_none Text to display for the 'no categories' option.
* Default 'No categories'.
* @type string $style The style used to display the categories list. If 'list', categories
* will be output as an unordered list. If left empty or another value,
* categories will be output separated by `<br>` tags. Default 'list'.
* @type string $separator Separator between links. Default '<br />'.
* @type string $taxonomy Taxonomy name. Default 'category'.
* @type string $title_li Text to use for the list title `<li>` element. Pass an empty string
* to disable. Default 'Categories'.
* @type bool|int $use_desc_for_title Whether to use the category description as the title attribute.
* Default 1.
* }
* @return false|string HTML content only if 'echo' argument is 0.
*/

View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '4.6-alpha-37570';
$wp_version = '4.6-alpha-37571';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.