Changeset 36135 for trunk

Timestamp:

12/31/2015 11:29:19 AM (10 years ago)

Author:

swissspidy

Message:

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.

File:

• trunk/src/wp-includes/category-template.php (modified) (2 diffs)

trunk/src/wp-includes/category-template.php

@@ -521 +521 @@
  *     @type int          $depth                 Category depth. Used for tab indentation. Default 0.
  *     @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.
@@ -526 +527 @@
 function wp_list_categories( $args = '' ) {
     $defaults = array(
-        'show_option_all' => '', 'show_option_none' => __('No categories'),
-        'orderby' => 'name', 'order' => 'ASC',
-        'style' => 'list',
-        'show_count' => 0, 'hide_empty' => 1,
-        'use_desc_for_title' => 1, 'child_of' => 0,
-        'feed' => '', 'feed_type' => '',
-        'feed_image' => '', 'exclude' => '',
-        'exclude_tree' => '', 'current_category' => 0,
-        'hierarchical' => true, 'title_li' => __( 'Categories' ),
+        'child_of'            => 0,
+        'current_category'    => 0,
+        'depth'               => 0,
+        'echo'                => 1,
+        'exclude'             => '',
+        'exclude_tree'        => '',
+        'feed'                => '',
+        'feed_image'          => '',
+        'feed_type'           => '',
+        'hide_empty'          => 1,
         'hide_title_if_empty' => false,
-        'echo' => 1, 'depth' => 0,
-        'separator' => '<br />',
-        'taxonomy' => 'category'
+        'hierarchical'        => true,
+        'order'               => 'ASC',
+        '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,
     );