WordPress.org

Make WordPress Core

Changeset 31005


Ignore:
Timestamp:
12/30/2014 08:48:34 PM (7 years ago)
Author:
boonebgorges
Message:

Use proper hash notation for wp_dropdown_categories() docblock.

See #30306.

File:
1 edited

Legend:

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

    r30982 r31005  
    288288 * Display or retrieve the HTML dropdown list of categories.
    289289 *
    290  * The list of arguments is below:
    291  *     'show_option_all' (string) - Text to display for showing all categories.
    292  *     'show_option_none' (string) - Text to display for showing no categories.
    293  *     'option_none_value' (mixed) - Value to use when no category is selected.
    294  *     'orderby' (string) default is 'ID' - What column to use for ordering the
    295  * categories.
    296  *     'order' (string) default is 'ASC' - What direction to order categories.
    297  *     'show_count' (bool|int) default is 0 - Whether to show how many posts are
    298  * in the category.
    299  *     'hide_empty' (bool|int) default is 1 - Whether to hide categories that
    300  * don't have any posts attached to them.
    301  *     'child_of' (int) default is 0 - See {@link get_categories()}.
    302  *     'exclude' (string) - See {@link get_categories()}.
    303  *     'echo' (bool|int) default is 1 - Whether to display or retrieve content.
    304  *     'depth' (int) - The max depth.
    305  *     'tab_index' (int) - Tab index for select element.
    306  *     'name' (string) - The name attribute value for select element.
    307  *     'id' (string) - The ID attribute value for select element. Defaults to name if omitted.
    308  *     'class' (string) - The class attribute value for select element.
    309  *     'selected' (int) - Which category ID is selected.
    310  *     'taxonomy' (string) - The name of the taxonomy to retrieve. Defaults to category.
    311  *
    312290 * The 'hierarchical' argument, which is disabled by default, will override the
    313291 * depth argument, unless it is true. When the argument is false, it will
     
    317295 * @since 2.1.0
    318296 *
    319  * @param string|array $args Optional. Override default arguments.
     297 * @param string|array $args {
     298 *     Array of arguments.
     299 *     @type string       $show_option_all   Optional. Text to display for showing all categories.
     300 *                                           Default is an empty string.
     301 *     @type string       $show_option_none  Optional. Text to display for showing no categories.
     302 *                                           Default is an empty string.
     303 *     @type string       $option_none_value Optional. Value to use when no category is selected.
     304 *                                           Default is an empty string.
     305 *     @type string       $orderby           Optional. Which column to use for ordering categories.
     306 *                                           See {@see get_terms()} for list of accepted values. Default: 'id' (term_id).
     307 *     @type string       $order             Optional. Whether to order terms in ascending or descending order.
     308 *                                           Accepts 'ASC' or 'DESC'. Default 'ASC'.
     309 *     @type bool         $pad_counts        Optional. See {@see get_terms()} for description. Default: false.
     310 *     @type bool|int     $show_count        Optional. Whether to include post counts. Accepts 0, 1, or their bool
     311 *                                           equivalents. Default 0.
     312 *     @type bool|int     $hide_empty        Optional. Whether to hide categories that don't have any posts.
     313 *                                           Accepts 0, 1, or their bool equivalents. Default 1.
     314 *     @type int          $child_of          Optional. Term ID to retrieve child terms of. See {@see get_terms()}.
     315 *                                           Default 0.
     316 *     @type array|string $exclude           Optional. Array or comma/space-separated string of term ids to exclude.
     317 *                                           If $include is non-empty, $exclude is ignored.
     318 *                                           Default empty array.
     319 *     @type bool|int     $echo              Optional. Whether to echo or return the generated markup. Accepts 0, 1,
     320 *                                           or their bool equivalents. Default 1.
     321 *     @type bool|int     $hierarchical      Optional. Whether to traverse the taxonomy hierarchy. Accepts 0, 1, or
     322 *                                           their bool equivalents. Default: 0.
     323 *     @type int          $depth             Optional. Maximum depth. Default 0.
     324 *     @type int          $tab_index         Optional. Tab index for the select element. Default 0 (no tabindex).
     325 *     @type string       $name              Optional. Value for the 'name' attribute of the select element.
     326 *                                           Default: 'cat'.
     327 *     @type string       $id                Optional. Value for the 'id' attribute of the select element.
     328 *                                           Defaults to the value of $name.
     329 *     @type string       $class             Optional. Value for the 'class' attribute of the select element.
     330 *     @type int          $selected          Optional. ID of the category to be selected.
     331 *     @type string       $taxonomy          Optional. Name of the category to retrieve. Default 'category'.
     332 *     @type bool         $hide_if_empty     Optional. True to skip generating markup if no categories are found.
     333 *                                           Default false (create select element even if no categories are found).
     334 *
     335 * }
    320336 * @return string HTML content only if 'echo' argument is 0.
    321337 */
Note: See TracChangeset for help on using the changeset viewer.