<?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
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.
* @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
*/
public function __construct( $manager, $id, $args = array() ) {
$keys = array_keys( get_object_vars( $this ) );
if ( $this->sanitize_js_callback )
add_filter( "customize_sanitize_js_{$this->id}", $this->sanitize_js_callback, 10, 2 );
+ }
+
+ /**
+ * 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 $this;
+ /**
+ * 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;
/**
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' :
/**
* 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()
*
* @return mixed New or old value.
*/
public function _preview_filter( $original ) {
+ if ( ! $this->is_current_blog_previewed() ) {
+ return $original;
+ }
+
$undefined = new stdClass(); // symbol hack
- $post_value = $this->manager->post_value( $this, $undefined );
+ $post_value = $this->post_value( $undefined );
if ( $undefined === $post_value ) {
$value = $this->_original_value;
} else {
*
* @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 ) )
* @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 );
}
/**
*
* @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;
*
* 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 {
*
* 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';
}
/**
- * 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';
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff