WordPress.org

Make WordPress Core

Changeset 40903


Ignore:
Timestamp:
06/15/2017 09:38:30 AM (2 years ago)
Author:
boonebgorges
Message:

Simplify documentation for wp_dropdown_categories().

Props ArnaudBan.
Fixes #41058.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/category-template.php

    r40816 r40903  
    276276 *
    277277 * @param string|array $args {
    278  *     Optional. Array or string of arguments to generate a categories drop-down element.
     278 *     Optional. Array or string of arguments to generate a categories drop-down element. See WP_Term_Query::__construct()
     279 *     for information on additional accepted arguments.
    279280 *
    280281 *     @type string       $show_option_all   Text to display for showing all categories. Default empty.
    281282 *     @type string       $show_option_none  Text to display for showing no categories. Default empty.
    282283 *     @type string       $option_none_value Value to use when no category is selected. Default empty.
    283  *     @type string       $orderby           Which column to use for ordering categories. See get_terms() for a list
    284  *                                           of accepted values. Default 'id' (term_id).
    285  *     @type string       $order             Whether to order terms in ascending or descending order. Accepts 'ASC'
    286  *                                           or 'DESC'. Default 'ASC'.
    287284 *     @type bool         $pad_counts        See get_terms() for an argument description. Default false.
    288285 *     @type bool|int     $show_count        Whether to include post counts. Accepts 0, 1, or their bool equivalents.
    289286 *                                           Default 0.
    290  *     @type bool|int     $hide_empty        Whether to hide categories that don't have any posts. Accepts 0, 1, or
    291  *                                           their bool equivalents. Default 1.
    292  *     @type int          $child_of          Term ID to retrieve child terms of. See get_terms(). Default 0.
    293  *     @type array|string $exclude           Array or comma/space-separated string of term ids to exclude.
    294  *                                           If `$include` is non-empty, `$exclude` is ignored. Default empty array.
    295287 *     @type bool|int     $echo              Whether to echo or return the generated markup. Accepts 0, 1, or their
    296288 *                                           bool equivalents. Default 1.
    297  *     @type bool|int     $hierarchical      Whether to traverse the taxonomy hierarchy. Accepts 0, 1, or their bool
    298  *                                           equivalents. Default 0.
    299289 *     @type int          $depth             Maximum depth. Default 0.
    300290 *     @type int          $tab_index         Tab index for the select element. Default 0 (no tabindex).
     
    308298 *                                           'slug', 'term_group', 'term_taxonomy_id', 'taxonomy', 'description',
    309299 *                                           'parent', 'count'. Default 'term_id'.
    310  *     @type string|array $taxonomy          Name of the category or categories to retrieve. Default 'category'.
    311300 *     @type bool         $hide_if_empty     True to skip generating markup if no categories are found.
    312301 *                                           Default false (create select element even if no categories are found).
Note: See TracChangeset for help on using the changeset viewer.