Changeset 36114

Timestamp:

12/28/2015 08:09:58 PM (11 years ago)

Author:

DrewAPicture

Message:

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

See #32246.

File:

• trunk/src/wp-includes/class-wp-customize-control.php (modified) (2 diffs)

trunk/src/wp-includes/class-wp-customize-control.php

@@ -134 +134 @@
          * Constructor.
          *
-         * Supplied $args override class property defaults.
-         *
-         * If $args['settings'] is not defined, use the $id as the setting ID.
+         * Supplied `$args` override class property defaults.
+         *
+         * If `$args['settings']` is not defined, use the $id as the setting ID.
          *
          * @since 3.4.0
@@ -142 +142 @@
          * @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() ) {