Docs: Improve readability of the default arguments of `wp_list_categories()`.

Adds missing documentation for the `separator` argument introduced in [35140].

Props birgire for initial patch.
Fixes #34751.

git-svn-id: https://develop.svn.wordpress.org/trunk@36135 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Pascal Birchler 2015-12-31 11:29:19 +00:00
parent b2b14848d6
commit b62421681e
1 changed files with 22 additions and 12 deletions

View File

@ -520,24 +520,34 @@ function wp_dropdown_categories( $args = '' ) {
* the list. Default false (title will always be shown). * the list. Default false (title will always be shown).
* @type int $depth Category depth. Used for tab indentation. Default 0. * @type int $depth Category depth. Used for tab indentation. Default 0.
* @type string $taxonomy Taxonomy name. Default 'category'. * @type string $taxonomy Taxonomy name. Default 'category'.
* @type string $separator Separator between links. Default '<br />'.
* } * }
* @return false|string HTML content only if 'echo' argument is 0. * @return false|string HTML content only if 'echo' argument is 0.
*/ */
function wp_list_categories( $args = '' ) { function wp_list_categories( $args = '' ) {
$defaults = array( $defaults = array(
'show_option_all' => '', 'show_option_none' => __('No categories'), 'child_of' => 0,
'orderby' => 'name', 'order' => 'ASC', 'current_category' => 0,
'style' => 'list', 'depth' => 0,
'show_count' => 0, 'hide_empty' => 1, 'echo' => 1,
'use_desc_for_title' => 1, 'child_of' => 0, 'exclude' => '',
'feed' => '', 'feed_type' => '', 'exclude_tree' => '',
'feed_image' => '', 'exclude' => '', 'feed' => '',
'exclude_tree' => '', 'current_category' => 0, 'feed_image' => '',
'hierarchical' => true, 'title_li' => __( 'Categories' ), 'feed_type' => '',
'hide_empty' => 1,
'hide_title_if_empty' => false, 'hide_title_if_empty' => false,
'echo' => 1, 'depth' => 0, 'hierarchical' => true,
'separator' => '<br />', 'order' => 'ASC',
'taxonomy' => 'category' 'orderby' => 'name',
'separator' => '<br />',
'show_count' => 0,
'show_option_all' => '',
'show_option_none' => __( 'No categories' ),
'style' => 'list',
'taxonomy' => 'category',
'title_li' => __( 'Categories' ),
'use_desc_for_title' => 1,
); );
$r = wp_parse_args( $args, $defaults ); $r = wp_parse_args( $args, $defaults );