vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-08-11 20:30:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Docs: Improve phpdoc for WP_Customize_Manager, WP_Customize_Control, WP_Customize_Setting, and WP_Customize_Selective_Refresh.

Browse Source 
Props 4nickpick, sagarprajapati, ketuchetan, BharatKambariya, mrahmadawais, westonruter.
Fixes #39671.


git-svn-id: https://develop.svn.wordpress.org/trunk@40804 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Weston Ruter
2017-05-19 20:24:58 +00:00
parent bf2de6a56b
commit cc5e4928ff
4 changed files with 249 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/wp-includes/class-wp-customize-control.php
+85 -22
View File
@@ -37,12 +37,18 @@ class WP_Customize_Control {
public $instance_number;
/**
* Customizer manager.
*
* @since 3.4.0
* @access public
* @var WP_Customize_Manager
*/
public $manager;
/**
* Control ID.
*
* @since 3.4.0
* @access public
* @var string
*/
@@ -51,6 +57,7 @@ class WP_Customize_Control {
/**
* All settings tied to the control.
*
* @since 3.4.0
* @access public
* @var array
*/
@@ -59,6 +66,7 @@ class WP_Customize_Control {
/**
* The primary setting for the control (if there is one).
*
* @since 3.4.0
* @access public
* @var string
*/
@@ -77,38 +85,56 @@ class WP_Customize_Control {
public $capability;
/**
* Order priority to load the control in Customizer.
*
* @since 3.4.0
* @access public
* @var int
*/
public $priority = 10;
/**
* Section the control belongs to.
*
* @since 3.4.0
* @access public
* @var string
*/
public $section = '';
/**
* Label for the control.
*
* @since 3.4.0
* @access public
* @var string
*/
public $label = '';
/**
* Description for the control.
*
* @since 4.0.0
* @access public
* @var string
*/
public $description = '';
/**
* @todo: Remove choices
* List of choices for 'radio' or 'select' type controls, where values are the keys, and labels are the values.
*
* @since 3.4.0
* @access public
* @var array
*/
public $choices = array();
/**
* 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.
*
* @since 4.0.0
* @access public
* @var array
*/
@@ -125,12 +151,16 @@ class WP_Customize_Control {
/**
* @deprecated It is better to just call the json() method
* @since 3.4.0
* @access public
* @var array
*/
public $json = array();
/**
* Control's Type.
*
* @since 3.4.0
* @access public
* @var string
*/
@@ -235,7 +265,6 @@ class WP_Customize_Control {
* Check whether control is active to current Customizer preview.
*
* @since 4.0.0
* @access public
*
* @return bool Whether the control is active to the current preview.
*/
@@ -263,7 +292,6 @@ class WP_Customize_Control {
* provide an 'active_callback' argument to the constructor.
*
* @since 4.0.0
* @access public
*
* @return true Always true.
*/
@@ -446,7 +474,6 @@ class WP_Customize_Control {
* Render the custom attributes for the control's input element.
*
* @since 4.0.0
* @access public
*/
public function input_attrs() {
foreach ( $this->input_attrs as $attr => $value ) {
@@ -648,56 +675,92 @@ class WP_Customize_Control {
}
/** WP_Customize_Color_Control class */
/**
* WP_Customize_Color_Control class.
*/
require_once( ABSPATH . WPINC . '/customize/class-wp-customize-color-control.php' );
/** WP_Customize_Media_Control class */
/**
* WP_Customize_Media_Control class.
*/
require_once( ABSPATH . WPINC . '/customize/class-wp-customize-media-control.php' );
/** WP_Customize_Upload_Control class */
/**
* WP_Customize_Upload_Control class.
*/
require_once( ABSPATH . WPINC . '/customize/class-wp-customize-upload-control.php' );
/** WP_Customize_Image_Control class */
/**
* WP_Customize_Image_Control class.
*/
require_once( ABSPATH . WPINC . '/customize/class-wp-customize-image-control.php' );
/** WP_Customize_Background_Image_Control class */
/**
* WP_Customize_Background_Image_Control class.
*/
require_once( ABSPATH . WPINC . '/customize/class-wp-customize-background-image-control.php' );
/** WP_Customize_Background_Position_Control class */
/**
* WP_Customize_Background_Position_Control class.
*/
require_once( ABSPATH . WPINC . '/customize/class-wp-customize-background-position-control.php' );
/** WP_Customize_Cropped_Image_Control class */
/**
* WP_Customize_Cropped_Image_Control class.
*/
require_once( ABSPATH . WPINC . '/customize/class-wp-customize-cropped-image-control.php' );
/** WP_Customize_Site_Icon_Control class */
/**
* WP_Customize_Site_Icon_Control class.
*/
require_once( ABSPATH . WPINC . '/customize/class-wp-customize-site-icon-control.php' );
/** WP_Customize_Header_Image_Control class */
/**
* WP_Customize_Header_Image_Control class.
*/
require_once( ABSPATH . WPINC . '/customize/class-wp-customize-header-image-control.php' );
/** WP_Customize_Theme_Control class */
/**
* WP_Customize_Theme_Control class.
*/
require_once( ABSPATH . WPINC . '/customize/class-wp-customize-theme-control.php' );
/** WP_Widget_Area_Customize_Control class */
/**
* WP_Widget_Area_Customize_Control class.
*/
require_once( ABSPATH . WPINC . '/customize/class-wp-widget-area-customize-control.php' );
/** WP_Widget_Form_Customize_Control class */
/**
* WP_Widget_Form_Customize_Control class.
*/
require_once( ABSPATH . WPINC . '/customize/class-wp-widget-form-customize-control.php' );
/** WP_Customize_Nav_Menu_Control class */
/**
* WP_Customize_Nav_Menu_Control class.
*/
require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-control.php' );
/** WP_Customize_Nav_Menu_Item_Control class */
/**
* WP_Customize_Nav_Menu_Item_Control class.
*/
require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-item-control.php' );
/** WP_Customize_Nav_Menu_Location_Control class */
/**
* WP_Customize_Nav_Menu_Location_Control class.
*/
require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-location-control.php' );
/** WP_Customize_Nav_Menu_Name_Control class */
/**
* WP_Customize_Nav_Menu_Name_Control class.
*/
require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-name-control.php' );
/** WP_Customize_Nav_Menu_Auto_Add_Control class */
/**
* WP_Customize_Nav_Menu_Auto_Add_Control class.
*/
require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-auto-add-control.php' );
/** WP_Customize_New_Menu_Control class */
/**
* WP_Customize_New_Menu_Control class.
*/
require_once( ABSPATH . WPINC . '/customize/class-wp-customize-new-menu-control.php' );