Update the Customizer API inline docs.

props ericlewis.
fixes #27065.


git-svn-id: https://develop.svn.wordpress.org/trunk@27398 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Andrew Nacin
2014-03-04 20:20:28 +00:00
parent 73a077d32b
commit a206152c10
5 changed files with 190 additions and 64 deletions
+13 -14
View File
@@ -39,19 +39,19 @@ class WP_Customize_Control {
* @access public
* @var int
*/
public $priority = 10;
public $priority = 10;
/**
* @access public
* @var string
*/
public $section = '';
public $section = '';
/**
* @access public
* @var string
*/
public $label = '';
public $label = '';
/**
* @todo: Remove choices
@@ -59,7 +59,7 @@ class WP_Customize_Control {
* @access public
* @var array
*/
public $choices = array();
public $choices = array();
/**
* @access public
@@ -77,6 +77,8 @@ class WP_Customize_Control {
/**
* Constructor.
*
* Supplied $args override class property defaults.
*
* If $args['settings'] is not defined, use the $id as the setting ID.
*
* @since 3.4.0
@@ -95,7 +97,6 @@ class WP_Customize_Control {
$this->manager = $manager;
$this->id = $id;
// Process settings.
if ( empty( $this->settings ) )
$this->settings = $id;
@@ -185,7 +186,7 @@ class WP_Customize_Control {
}
/**
* 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
*/
@@ -199,7 +200,7 @@ class WP_Customize_Control {
}
/**
* Get the data link parameter for a setting.
* Get the data link attribute for a setting.
*
* @since 3.4.0
*
@@ -214,7 +215,7 @@ class WP_Customize_Control {
}
/**
* Render the data link parameter for a setting
* Render the data link attribute for the control's input element.
*
* @since 3.4.0
* @uses WP_Customize_Control::get_link()
@@ -228,7 +229,9 @@ class WP_Customize_Control {
/**
* 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
*/
@@ -331,8 +334,6 @@ class WP_Customize_Color_Control extends WP_Customize_Control {
/**
* Constructor.
*
* If $args['settings'] is not defined, use the $id as the setting ID.
*
* @since 3.4.0
* @uses WP_Customize_Control::__construct()
*
@@ -346,7 +347,7 @@ class WP_Customize_Color_Control extends WP_Customize_Control {
}
/**
* Enqueue control related scripts/styles.
* Enqueue scripts/styles for the color picker.
*
* @since 3.4.0
*/
@@ -467,8 +468,6 @@ class WP_Customize_Image_Control extends WP_Customize_Upload_Control {
/**
* Constructor.
*
* If $args['settings'] is not defined, use the $id as the setting ID.
*
* @since 3.4.0
* @uses WP_Customize_Upload_Control::__construct()
*