Ticket #21303: diff.patch

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

@@ -6 +6 @@
  * @subpackage Customize
  * @since 3.4.0
  */
-
 class WP_Customize_Control {
+        /**
+         * @access public
+         * @var WP_Customize_Manager
+         */
         public $manager;
+        
+        /**
+         * @access public
+         * @var int
+         */
         public $id;
 
-        // All settings tied to the control.
+        /**
+         * All settings tied to the control.
+         *
+         * @access public
+         * @var array
+         */
         public $settings;
 
-        // The primary setting for the control (if there is one).
+        /**
+         * The primary setting for the control (if there is one).
+         *
+         * @access public
+         * @var string
+         */
         public $setting = 'default';
 
+        /**
+         * @access public
+         * @var int
+         */
         public $priority          = 10;
+        
+        /**
+         * @access public
+         * @var string
+         */
         public $section           = '';
+        
+        /**
+         * @access public
+         * @var string
+         */
         public $label             = '';
-        // @todo: remove choices
+        
+        /**
+         * @todo: Remove choices
+         *
+         * @access public
+         * @var array
+         */
         public $choices           = array();
 
+        /**
+         * @access public
+         * @var array
+         */
         public $json = array();
 
+        /**
+         * @access public
+         * @var string
+         */
         public $type = 'text';
 
 
@@ -34 +80 @@
          * If $args['settings'] is not defined, use the $id as the setting ID.
          *
          * @since 3.4.0
+         *
+         * @param WP_Customize_Manager $manager
+         * @param int $id
+         * @param array $args
          */
         function __construct( $manager, $id, $args = array() ) {
                 $keys = array_keys( get_object_vars( $this ) );
@@ -75 +125 @@
          * Grabs the main setting by default.
          *
          * @since 3.4.0
+         *
+         * @param string $setting_key
+         * @return mixed The requested setting's value, if the setting exists.
          */
         public final function value( $setting_key = 'default' ) {
                 if ( isset( $this->settings[ $setting_key ] ) )
@@ -119 +172 @@
          * Check capabilities and render the control.
          *
          * @since 3.4.0
+         * @see render()
          */
         public final function maybe_render() {
                 if ( ! $this->check_capabilities() )
@@ -143 +197 @@
                         <?php $this->render_content(); ?>
                 </li><?php
         }
-
+        
+        /**
+         * Get the data link parameter for a setting.
+         *
+         * @since 3.4.0
+         *
+         * @param string $setting_key
+         * @return string Data link parameter, if $setting_key is a valid setting, empty string otherwise.
+         */
         public function get_link( $setting_key = 'default' ) {
                 if ( ! isset( $this->settings[ $setting_key ] ) )
                         return '';
 
                 return 'data-customize-setting-link="' . esc_attr( $this->settings[ $setting_key ]->id ) . '"';
         }
-
+        
+        /**
+         * Render the data link parameter for a setting
+         *
+         * @since 3.4.0
+         * @see get_link()
+         *
+         * @param string $setting_key
+         */
         public function link( $setting_key = 'default' ) {
                 echo $this->get_link( $setting_key );
         }