Changeset 33763

Timestamp:

08/26/2015 03:29:35 PM (9 years ago)

Author:

boonebgorges

Message:

Use proper array documentation formatting for wp_list_categories().

This changeset also corrects a few parameter descriptions, and adds a few that
were previously missing.

Fixes #33556.

File:

• trunk/src/wp-includes/category-template.php (modified) (1 diff)

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

@@ -461 +461 @@
  * Display or retrieve the HTML list of categories.
  *
- * The list of arguments is below:
- *     'show_option_all' (string) - Text to display for showing all categories.
- *     'orderby' (string) default is 'ID' - What column to use for ordering the
- * categories.
- *     'order' (string) default is 'ASC' - What direction to order categories.
- *     'show_count' (bool|int) default is 0 - Whether to show how many posts are
- * in the category.
- *     'hide_empty' (bool|int) default is 1 - Whether to hide categories that
- * don't have any posts attached to them.
- *     'use_desc_for_title' (bool|int) default is 1 - Whether to use the
- * category description as the title attribute.
- *     'feed' - See {@link get_categories()}.
- *     'feed_type' - See {@link get_categories()}.
- *     'feed_image' - See {@link get_categories()}.
- *     'child_of' (int) default is 0 - See {@link get_categories()}.
- *     'exclude' (string) - See {@link get_categories()}.
- *     'exclude_tree' (string) - See {@link get_categories()}.
- *     'echo' (bool|int) default is 1 - Whether to display or retrieve content.
- *     'current_category' (int) - See {@link get_categories()}.
- *     'hierarchical' (bool) - See {@link get_categories()}.
- *     'title_li' (string) - See {@link get_categories()}.
- *     'depth' (int) - The max depth.
- *
  * @since 2.1.0
  *
- * @param string|array $args Optional. Override default arguments.
+ * @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 {@link 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 {@link get_terms()}. Default 0.
+ *     @type array|string $exclude            Array or comma/space-separated string of term IDs to exclude.
+ *                                            See {@link 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 {@link get_terms()}. Default empty string.
+ *     @type bool|int     $echo               True to echo markup, false to return it. Default 1.
+ *     @type int          $current_category   Category that should get the 'current-cat' class. Default 0.
+ *     @type bool         $hierarchical       Whether to include terms that have non-empty descendants.
+ *                                            See {@link 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 int          $depth              Category depth. Used for tab indentation. Default 0.
+ *     @type string       $taxonomy           Taxonomy name. Default 'category'.
+ * }
  * @return false|string HTML content only if 'echo' argument is 0.
  */