WordPress.org

Make WordPress Core

Changeset 31356


Ignore:
Timestamp:
02/06/2015 08:55:52 AM (7 years ago)
Author:
DrewAPicture
Message:

Adjust the DocBlock for wp_dropdown_pages() to mark the entire $args parameter array as optional instead of each individual argument.

See #12494.

File:
1 edited

Legend:

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

    r31355 r31356  
    946946 *
    947947 * @param array|string $args {
    948  *     Array of function arguments. Optional.
    949  *
    950  *     @type int          $depth                  Optional. Maximum depth. Default 0.
    951  *     @type int          $child_of               Optional. Page ID to retrieve child pages of.
    952  *                                                Default 0.
    953  *     @type int|string   $selected               Optional. Value of the option that should be selected.
    954  *     @type bool|int     $echo                   Optional. Whether to echo or return the generated markup.
    955  *                                                Accepts 0, 1, or their bool equivalents. Default 1.
    956  *     @type string       $name                   Optional. Value for the 'name' attribute of the select element.
    957  *                                                Default: 'page_id'.
    958  *     @type string       $id                     Optional. Value for the 'id' attribute of the select element.
    959  *                                                Defaults to the value of $name.
    960  *     @type string       $show_option_none       Optional. Text to display for showing no pages.
    961  *                                                Default is an empty string (does not display).
    962  *     @type string       $show_option_no_change  Optional. Text to display for "no change" option.
    963  *                                                Default is an empty string (does not display).
    964  *     @type string       $option_none_value      Optional. Value to use when no page is selected.
    965  *                                                Default is an empty string.
    966  *     @type string       $value_field            Post field used to populate the 'value' attribute of the option
    967  *                                                elements. Accepts any valid post field. Default 'ID'.
     948 *     Optional. Array or string of arguments to generate a pages drop-down element.
     949 *
     950 *     @type int          $depth                 Maximum depth. Default 0.
     951 *     @type int          $child_of              Page ID to retrieve child pages of. Default 0.
     952 *     @type int|string   $selected              Value of the option that should be selected. Default 0.
     953 *     @type bool|int     $echo                  Whether to echo or return the generated markup. Accepts 0, 1,
     954 *                                               or their bool equivalents. Default 1.
     955 *     @type string       $name                  Value for the 'name' attribute of the select element.
     956 *                                               Default 'page_id'.
     957 *     @type string       $id                    Value for the 'id' attribute of the select element.
     958 *                                               Defaults to the value of `$name`.
     959 *     @type string       $show_option_none      Text to display for showing no pages. Default empty (does not display).
     960 *     @type string       $show_option_no_change Text to display for "no change" option. Default empty (does not display).
     961 *     @type string       $option_none_value     Value to use when no page is selected. Default empty.
     962 *     @type string       $value_field           Post field used to populate the 'value' attribute of the option
     963 *                                               elements. Accepts any valid post field. Default 'ID'.
    968964 * }
    969965 * @return string HTML content, if not displaying.
Note: See TracChangeset for help on using the changeset viewer.