sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Taxonomy: Standardize docs for wp_list_categories().

Browse Source 
Many of the parameters historically documented on this function are merely
passed through to `get_categories()` and its underlying functions. In order to
avoid unnecessary duplication of function arguments, we remove documentation of
these parameters, and replace it with reference to the wrapped functions.

Parameters that receive special treatment or are otherwise changed before
being passed through continue to be documented as part of `wp_list_categories()`.

Props audrasjb, itowhid06, birgire.
Fixes #47896.

git-svn-id: https://develop.svn.wordpress.org/trunk@45894 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Boone Gorges 2019-08-26 15:23:48 +00:00
parent c2c8a6848d
commit 7dac24c681
1 changed files with 2 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/wp-includes/category-template.php
View File

@ -470,9 +470,9 @@ function wp_dropdown_categories( $args = '' ) {
* optionally accept an array of values. * optionally accept an array of values.
* *
* @param string|array $args { * @param string|array $args {
* Array of optional arguments. * Array of optional arguments. See get_categories(), get_terms(), and WP_Tax_Query::construct()
* for full lists of arguments that can be passed in `$args`.
* *
* @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 * @type int|array $current_category ID of category, or array of IDs of categories, that should get the
* 'current-cat' class. Default 0. * 'current-cat' class. Default 0.
* @type int $depth Category depth. Used for tab indentation. Default 0. * @type int $depth Category depth. Used for tab indentation. Default 0.
@ -488,15 +488,8 @@ function wp_dropdown_categories( $args = '' ) {
* @type string $feed_image URL of an image to use for the feed link. Default empty string. * @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(). * @type string $feed_type Feed type. Used to build feed link. See get_term_feed_link().
* Default empty string (default feed). * 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 * @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). * the list. Default false (title will always be shown).
* @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 'name'.
* @type string $separator Separator between links. Default '<br />'. * @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 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_all Text to display for showing all categories. Default empty string.
@ -505,7 +498,6 @@ function wp_dropdown_categories( $args = '' ) {
* @type string $style The style used to display the categories list. If 'list', 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, * will be output as an unordered list. If left empty or another value,
* categories will be output separated by `<br>` tags. Default 'list'. * categories will be output separated by `<br>` tags. Default 'list'.
* @type string $taxonomy Taxonomy name. Default 'category'.
* @type string $title_li Text to use for the list title `<li>` element. Pass an empty string * @type string $title_li Text to use for the list title `<li>` element. Pass an empty string
* to disable. Default 'Categories'. * to disable. Default 'Categories'.
* @type bool|int $use_desc_for_title Whether to use the category description as the title attribute. * @type bool|int $use_desc_for_title Whether to use the category description as the title attribute.