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

See #12494.


git-svn-id: https://develop.svn.wordpress.org/trunk@31356 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-02-06 08:55:52 +00:00
parent 53209f19b3
commit 475337bd97

View File

@ -945,24 +945,20 @@ function the_meta() {
* @since 4.2.0 The `$value_field` argument was added.
*
* @param array|string $args {
* Array of function arguments. Optional.
* Optional. Array or string of arguments to generate a pages drop-down element.
*
* @type int $depth Optional. Maximum depth. Default 0.
* @type int $child_of Optional. Page ID to retrieve child pages of.
* Default 0.
* @type int|string $selected Optional. Value of the option that should be selected.
* @type bool|int $echo Optional. Whether to echo or return the generated markup.
* Accepts 0, 1, or their bool equivalents. Default 1.
* @type string $name Optional. Value for the 'name' attribute of the select element.
* Default: 'page_id'.
* @type string $id Optional. Value for the 'id' attribute of the select element.
* Defaults to the value of $name.
* @type string $show_option_none Optional. Text to display for showing no pages.
* Default is an empty string (does not display).
* @type string $show_option_no_change Optional. Text to display for "no change" option.
* Default is an empty string (does not display).
* @type string $option_none_value Optional. Value to use when no page is selected.
* Default is an empty string.
* @type int $depth Maximum depth. Default 0.
* @type int $child_of Page ID to retrieve child pages of. Default 0.
* @type int|string $selected Value of the option that should be selected. Default 0.
* @type bool|int $echo Whether to echo or return the generated markup. Accepts 0, 1,
* or their bool equivalents. Default 1.
* @type string $name Value for the 'name' attribute of the select element.
* Default 'page_id'.
* @type string $id Value for the 'id' attribute of the select element.
* Defaults to the value of `$name`.
* @type string $show_option_none Text to display for showing no pages. Default empty (does not display).
* @type string $show_option_no_change Text to display for "no change" option. Default empty (does not display).
* @type string $option_none_value Value to use when no page is selected. Default empty.
* @type string $value_field Post field used to populate the 'value' attribute of the option
* elements. Accepts any valid post field. Default 'ID'.
* }