Docs: Hash notate properties and defaults for the benefit of $args parameter documentation for WP_Customize_Control::__construct().

See #32246.

Built from https://develop.svn.wordpress.org/trunk@36114


git-svn-id: http://core.svn.wordpress.org/trunk@36079 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2015-12-28 20:10:35 +00:00
parent 5540c0b8db
commit 23a6ee1af1
2 changed files with 31 additions and 4 deletions

View File

@ -133,15 +133,42 @@ class WP_Customize_Control {
/**
* Constructor.
*
* Supplied $args override class property defaults.
* Supplied `$args` override class property defaults.
*
* If $args['settings'] is not defined, use the $id as the setting ID.
* If `$args['settings']` is not defined, use the $id as the setting ID.
*
* @since 3.4.0
*
* @param WP_Customize_Manager $manager Customizer bootstrap instance.
* @param string $id Control ID.
* @param array $args Optional. Arguments to override class property defaults.
* @param array $args {
* Optional. Arguments to override class property defaults.
*
* @type int $instance_number Order in which this instance was created in relation
* to other instances.
* @type WP_Customize_Manager $manager Customizer bootstrap instance.
* @type string $id Control ID.
* @type array $settings All settings tied to the control. If undefined, `$id` will
* be used.
* @type string $setting The primary setting for the control (if there is one).
* Default 'default'.
* @type int $priority Order priority to load the control. Default 10.
* @type string $section Section the control belongs to. Default empty.
* @type string $label Label for the control. Default empty.
* @type string $description Description for the control. Default empty.
* @type array $choices List of choices for 'radio' or 'select' type controls, where
* values are the keys, and labels are the values.
* Default empty array.
* @type array $input_attrs List of custom input attributes for control output, where
* attribute names are the keys and values are the values. Not
* used for 'checkbox', 'radio', 'select', 'textarea', or
* 'dropdown-pages' control types. Default empty array.
* @type array $json Deprecated. Use {@see WP_Customize_Control->json()} instead.
* @type string $type Control type. Core controls include 'text', 'checkbox',
* 'textarea', 'radio', 'select', and 'dropdown-pages'. Additional
* input types such as 'email', 'url', 'number', 'hidden', and
* 'date' are supported implicitly. Default 'text'.
* }
*/
public function __construct( $manager, $id, $args = array() ) {
$keys = array_keys( get_object_vars( $this ) );

View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '4.5-alpha-36113';
$wp_version = '4.5-alpha-36114';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.