Changeset 27398 for trunk/src/wp-includes/class-wp-customize-control.php

Timestamp:

03/04/2014 08:20:28 PM (11 years ago)

Author:

nacin

Message:

Update the Customizer API inline docs.

props ericlewis.
fixes #27065.

File:

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

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

@@ -40 +40 @@
      * @var int
      */
-    public $priority          = 10;
+    public $priority = 10;
 
     /**
@@ -46 +46 @@
      * @var string
      */
-    public $section           = '';
+    public $section = '';
 
     /**
@@ -52 +52 @@
      * @var string
      */
-    public $label             = '';
+    public $label = '';
 
     /**
@@ -60 +60 @@
      * @var array
      */
-    public $choices           = array();
+    public $choices = array();
 
     /**
@@ -77 +77 @@
     /**
      * Constructor.
+     *
+     * Supplied $args override class property defaults.
      *
      * If $args['settings'] is not defined, use the $id as the setting ID.
@@ -95 +97 @@
         $this->manager = $manager;
         $this->id = $id;
-
 
         // Process settings.
@@ -186 +187 @@
 
     /**
-     * Render the control. Renders the control wrapper, then calls $this->render_content().
+     * Renders the control wrapper and calls $this->render_content() for the internals.
      *
      * @since 3.4.0
@@ -200 +201 @@
 
     /**
-     * Get the data link parameter for a setting.
+     * Get the data link attribute for a setting.
      *
      * @since 3.4.0
@@ -215 +216 @@
 
     /**
-     * Render the data link parameter for a setting
+     * Render the data link attribute for the control's input element.
      *
      * @since 3.4.0
@@ -229 +230 @@
      * Render the control's content.
      *
-     * Allows the content to be overriden without having to rewrite the wrapper.
+     * Allows the content to be overriden without having to rewrite the wrapper in $this->render().
+     *
+     * Supports basic input types `text`, `checkbox`, `radio`, `select` and `dropdown-pages`.
      *
      * @since 3.4.0
@@ -332 +335 @@
      * Constructor.
      *
-     * If $args['settings'] is not defined, use the $id as the setting ID.
-     *
      * @since 3.4.0
      * @uses WP_Customize_Control::__construct()
@@ -347 +348 @@
 
     /**
-     * Enqueue control related scripts/styles.
+     * Enqueue scripts/styles for the color picker.
      *
      * @since 3.4.0
@@ -467 +468 @@
     /**
      * Constructor.
-     *
-     * If $args['settings'] is not defined, use the $id as the setting ID.
      *
      * @since 3.4.0