WordPress 4.2
[autoinstalls/wordpress.git] / wp-includes / class-wp-customize-setting.php
index bf75426a138d71925dbb416d1e00008784539791..f8f9ce083b9d786d508db9f27044ba8759a828d0 100644 (file)
@@ -1,13 +1,21 @@
 <?php
 /**
- * Customize Setting Class.
- *
- * Handles saving and sanitizing of settings.
+ * WordPress Customize Setting classes
  *
  * @package WordPress
  * @subpackage Customize
  * @since 3.4.0
  */
+
+/**
+ * Customize Setting class.
+ *
+ * Handles saving and sanitizing of settings.
+ *
+ * @since 3.4.0
+ *
+ * @see WP_Customize_Manager
+ */
 class WP_Customize_Setting {
        /**
         * @access public
@@ -52,15 +60,21 @@ class WP_Customize_Setting {
        public $sanitize_callback    = '';
        public $sanitize_js_callback = '';
 
-       protected $id_data = array();
-
        /**
-        * Cached and sanitized $_POST value for the setting.
+        * Whether or not the setting is initially dirty when created.
         *
-        * @access private
-        * @var mixed
+        * This is used to ensure that a setting will be sent from the pane to the
+        * preview when loading the Customizer. Normally a setting only is synced to
+        * the preview if it has been changed. This allows the setting to be sent
+        * from the start.
+        *
+        * @since 4.2.0
+        * @access public
+        * @var bool
         */
-       private $_post_value;
+       public $dirty = false;
+
+       protected $id_data = array();
 
        /**
         * Constructor.
@@ -73,10 +87,9 @@ class WP_Customize_Setting {
         * @param string               $id      An specific ID of the setting. Can be a
         *                                      theme mod or option name.
         * @param array                $args    Setting arguments.
-        * @return WP_Customize_Setting $setting
         */
-       function __construct( $manager, $id, $args = array() ) {
-               $keys = array_keys( get_class_vars( __CLASS__ ) );
+       public function __construct( $manager, $id, $args = array() ) {
+               $keys = array_keys( get_object_vars( $this ) );
                foreach ( $keys as $key ) {
                        if ( isset( $args[ $key ] ) )
                                $this->$key = $args[ $key ];
@@ -99,16 +112,54 @@ class WP_Customize_Setting {
 
                if ( $this->sanitize_js_callback )
                        add_filter( "customize_sanitize_js_{$this->id}", $this->sanitize_js_callback, 10, 2 );
+       }
 
-               return $this;
+       /**
+        * The ID for the current blog when the preview() method was called.
+        *
+        * @since 4.2.0
+        * @access protected
+        * @var int
+        */
+       protected $_previewed_blog_id;
+
+       /**
+        * Return true if the current blog is not the same as the previewed blog.
+        *
+        * @since 4.2.0
+        * @access public
+        *
+        * @return bool|null Returns null if preview() has not been called yet.
+        */
+       public function is_current_blog_previewed() {
+               if ( ! isset( $this->_previewed_blog_id ) ) {
+                       return null;
+               }
+               return ( get_current_blog_id() === $this->_previewed_blog_id );
        }
 
+       /**
+        * Original non-previewed value stored by the preview method.
+        *
+        * @see WP_Customize_Setting::preview()
+        * @since 4.1.1
+        * @var mixed
+        */
+       protected $_original_value;
+
        /**
         * Handle previewing the setting.
         *
         * @since 3.4.0
         */
        public function preview() {
+               if ( ! isset( $this->_original_value ) ) {
+                       $this->_original_value = $this->value();
+               }
+               if ( ! isset( $this->_previewed_blog_id ) ) {
+                       $this->_previewed_blog_id = get_current_blog_id();
+               }
+
                switch( $this->type ) {
                        case 'theme_mod' :
                                add_filter( 'theme_mod_' . $this->id_data[ 'base' ], array( $this, '_preview_filter' ) );
@@ -124,20 +175,38 @@ class WP_Customize_Setting {
                        default :
 
                                /**
-                                * Fires when the WP_Customize_Setting::preview() method is called for settings
+                                * Fires when the {@see WP_Customize_Setting::preview()} method is called for settings
                                 * not handled as theme_mods or options.
                                 *
-                                * The dynamic portion of the hook name, $this->id, refers to the setting ID.
+                                * The dynamic portion of the hook name, `$this->id`, refers to the setting ID.
                                 *
                                 * @since 3.4.0
+                                *
+                                * @param WP_Customize_Setting $this {@see WP_Customize_Setting} instance.
                                 */
-                               do_action( 'customize_preview_' . $this->id );
+                               do_action( "customize_preview_{$this->id}", $this );
+
+                               /**
+                                * Fires when the {@see WP_Customize_Setting::preview()} method is called for settings
+                                * not handled as theme_mods or options.
+                                *
+                                * The dynamic portion of the hook name, `$this->type`, refers to the setting type.
+                                *
+                                * @since 4.1.0
+                                *
+                                * @param WP_Customize_Setting $this {@see WP_Customize_Setting} instance.
+                                */
+                               do_action( "customize_preview_{$this->type}", $this );
                }
        }
 
        /**
         * Callback function to filter the theme mods and options.
         *
+        * If switch_to_blog() was called after the preview() method, and the current
+        * blog is now not the same blog, then this method does a no-op and returns
+        * the original value.
+        *
         * @since 3.4.0
         * @uses WP_Customize_Setting::multidimensional_replace()
         *
@@ -145,7 +214,19 @@ class WP_Customize_Setting {
         * @return mixed New or old value.
         */
        public function _preview_filter( $original ) {
-               return $this->multidimensional_replace( $original, $this->id_data[ 'keys' ], $this->post_value() );
+               if ( ! $this->is_current_blog_previewed() ) {
+                       return $original;
+               }
+
+               $undefined = new stdClass(); // symbol hack
+               $post_value = $this->post_value( $undefined );
+               if ( $undefined === $post_value ) {
+                       $value = $this->_original_value;
+               } else {
+                       $value = $post_value;
+               }
+
+               return $this->multidimensional_replace( $original, $this->id_data['keys'], $value );
        }
 
        /**
@@ -154,24 +235,25 @@ class WP_Customize_Setting {
         *
         * @since 3.4.0
         *
-        * @return bool False if cap check fails or value isn't set.
+        * @return false|null False if cap check fails or value isn't set.
         */
-       public final function save() {
+       final public function save() {
                $value = $this->post_value();
 
                if ( ! $this->check_capabilities() || ! isset( $value ) )
                        return false;
 
                /**
-                * Fires when the WP_Customize_Setting::save() method is called for settings
-                * not handled as theme_mods or options.
+                * Fires when the WP_Customize_Setting::save() method is called.
                 *
-                * The dynamic portion of the hook name, $this->id_data['base'] refers to
+                * The dynamic portion of the hook name, `$this->id_data['base']` refers to
                 * the base slug of the setting name.
                 *
                 * @since 3.4.0
+                *
+                * @param WP_Customize_Setting $this {@see WP_Customize_Setting} instance.
                 */
-               do_action( 'customize_save_' . $this->id_data[ 'base' ] );
+               do_action( 'customize_save_' . $this->id_data[ 'base' ], $this );
 
                $this->update( $value );
        }
@@ -184,18 +266,8 @@ class WP_Customize_Setting {
         * @param mixed $default A default value which is used as a fallback. Default is null.
         * @return mixed The default value on failure, otherwise the sanitized value.
         */
-       public final function post_value( $default = null ) {
-               // Check for a cached value
-               if ( isset( $this->_post_value ) )
-                       return $this->_post_value;
-
-               // Call the manager for the post value
-               $result = $this->manager->post_value( $this );
-
-               if ( isset( $result ) )
-                       return $this->_post_value = $result;
-               else
-                       return $default;
+       final public function post_value( $default = null ) {
+               return $this->manager->post_value( $this, $default );
        }
 
        /**
@@ -232,23 +304,24 @@ class WP_Customize_Setting {
                switch( $this->type ) {
                        case 'theme_mod' :
                                return $this->_update_theme_mod( $value );
-                               break;
+
                        case 'option' :
                                return $this->_update_option( $value );
-                               break;
+
                        default :
 
                                /**
-                                * Fires when the WP_Customize_Setting::update() method is called for settings
+                                * Fires when the {@see WP_Customize_Setting::update()} method is called for settings
                                 * not handled as theme_mods or options.
                                 *
-                                * The dynamic portion of the hook name, $this->type, refers to the type of setting.
+                                * The dynamic portion of the hook name, `$this->type`, refers to the type of setting.
                                 *
                                 * @since 3.4.0
                                 *
-                                * @param mixed $value Value of the setting.
+                                * @param mixed                $value Value of the setting.
+                                * @param WP_Customize_Setting $this  WP_Customize_Setting instance.
                                 */
-                               return do_action( 'customize_update_' . $this->type, $value );
+                               return do_action( 'customize_update_' . $this->type, $value, $this );
                }
        }
 
@@ -278,7 +351,7 @@ class WP_Customize_Setting {
         * @since 3.4.0
         *
         * @param mixed $value The value to update.
-        * @return mixed The result of saving the value.
+        * @return bool|null The result of saving the value.
         */
        protected function _update_option( $value ) {
                // Handle non-array option.
@@ -313,7 +386,7 @@ class WP_Customize_Setting {
                                /**
                                 * Filter a Customize setting value not handled as a theme_mod or option.
                                 *
-                                * The dynamic portion of the hook name, $this->id_date['base'], refers to
+                                * The dynamic portion of the hook name, `$this->id_date['base']`, refers to
                                 * the base slug of the setting name.
                                 *
                                 * For settings handled as theme_mods or options, see those corresponding
@@ -347,12 +420,12 @@ class WP_Customize_Setting {
                /**
                 * Filter a Customize setting value for use in JavaScript.
                 *
-                * The dynamic portion of the hook name, $this->id, refers to the setting ID.
+                * The dynamic portion of the hook name, `$this->id`, refers to the setting ID.
                 *
                 * @since 3.4.0
                 *
                 * @param mixed                $value The setting value.
-                * @param WP_Customize_Setting $this  WP_Customize_Setting instance.
+                * @param WP_Customize_Setting $this  {@see WP_Customize_Setting} instance.
                 */
                $value = apply_filters( "customize_sanitize_js_{$this->id}", $this->value(), $this );
 
@@ -369,7 +442,7 @@ class WP_Customize_Setting {
         *
         * @return bool False if theme doesn't support the setting or user can't change setting, otherwise true.
         */
-       public final function check_capabilities() {
+       final public function check_capabilities() {
                if ( $this->capability && ! call_user_func_array( 'current_user_can', (array) $this->capability ) )
                        return false;
 
@@ -409,8 +482,15 @@ class WP_Customize_Setting {
                        $node = &$node[ $key ];
                }
 
-               if ( $create && ! isset( $node[ $last ] ) )
-                       $node[ $last ] = array();
+               if ( $create ) {
+                       if ( ! is_array( $node ) ) {
+                               // account for an array overriding a string or object value
+                               $node = array();
+                       }
+                       if ( ! isset( $node[ $last ] ) ) {
+                               $node[ $last ] = array();
+                       }
+               }
 
                if ( ! isset( $node[ $last ] ) )
                        return;
@@ -453,7 +533,7 @@ class WP_Customize_Setting {
         *
         * @param $root
         * @param $keys
-        * @param $default A default value which is used as a fallback. Default is null.
+        * @param mixed $default A default value which is used as a fallback. Default is null.
         * @return mixed The requested value or the default value.
         */
        final protected function multidimensional_get( $root, $keys, $default = null ) {
@@ -484,9 +564,9 @@ class WP_Customize_Setting {
  *
  * Results should be properly handled using another setting or callback.
  *
- * @package WordPress
- * @subpackage Customize
  * @since 3.4.0
+ *
+ * @see WP_Customize_Setting
  */
 class WP_Customize_Filter_Setting extends WP_Customize_Setting {
 
@@ -501,9 +581,9 @@ class WP_Customize_Filter_Setting extends WP_Customize_Setting {
  *
  * Results should be properly handled using another setting or callback.
  *
- * @package WordPress
- * @subpackage Customize
  * @since 3.4.0
+ *
+ * @see WP_Customize_Setting
  */
 final class WP_Customize_Header_Image_Setting extends WP_Customize_Setting {
        public $id = 'header_image_data';
@@ -529,18 +609,17 @@ final class WP_Customize_Header_Image_Setting extends WP_Customize_Setting {
 }
 
 /**
- * Class WP_Customize_Background_Image_Setting
+ * Customizer Background Image Setting class.
  *
- * @package WordPress
- * @subpackage Customize
  * @since 3.4.0
+ *
+ * @see WP_Customize_Setting
  */
 final class WP_Customize_Background_Image_Setting extends WP_Customize_Setting {
        public $id = 'background_image_thumb';
 
        /**
         * @since 3.4.0
-        * @uses remove_theme_mod()
         *
         * @param $value
         */