* WordPress Customize Setting classes
if ( ! defined( 'ABSPATH' ) ) {
* Customize Setting class.
* Handles saving and sanitizing of settings.
* @see WP_Customize_Manager
* @link https://developer.wordpress.org/themes/customize-api
#[AllowDynamicProperties]
class WP_Customize_Setting {
* Customizer bootstrap instance.
* @var WP_Customize_Manager
* Unique string identifier for the setting.
* Type of customize settings.
public $type = 'theme_mod';
* Capability required to edit this setting.
public $capability = 'edit_theme_options';
* Theme features required to support the setting.
public $theme_supports = '';
* The default value for the setting.
* Options for rendering the live preview of changes in Customizer.
* Set this value to 'postMessage' to enable a custom JavaScript handler to render changes to this setting
* as opposed to reloading the whole page.
public $transport = 'refresh';
* Server-side validation callback for the setting's value.
public $validate_callback = '';
* Callback to filter a Customize setting value in un-slashed form.
public $sanitize_callback = '';
* Callback to convert a Customize PHP setting value to a value that is JSON serializable.
public $sanitize_js_callback = '';
* Whether or not the setting is initially dirty when created.
* 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
protected $id_data = array();
* Whether or not preview() was called.
protected $is_previewed = false;
* Cache of multidimensional values to improve performance.
protected static $aggregated_multidimensionals = array();
* Whether the multidimensional setting is aggregated.
protected $is_multidimensional_aggregated = false;
* Any supplied $args override class property defaults.
* @param WP_Customize_Manager $manager Customizer bootstrap instance.
* @param string $id A specific ID of the setting.
* Can be a theme mod or option name.
* Optional. Array of properties for the new Setting object. Default empty array.
* @type string $type Type of the setting. Default 'theme_mod'.
* @type string $capability Capability required for the setting. Default 'edit_theme_options'
* @type string|string[] $theme_supports Theme features required to support the panel. Default is none.
* @type string $default Default value for the setting. Default is empty string.
* @type string $transport Options for rendering the live preview of changes in Customizer.
* Using 'refresh' makes the change visible by reloading the whole preview.
* Using 'postMessage' allows a custom JavaScript to handle live changes.
* @type callable $validate_callback Server-side validation callback for the setting's value.
* @type callable $sanitize_callback Callback to filter a Customize setting value in un-slashed form.
* @type callable $sanitize_js_callback Callback to convert a Customize PHP setting value to a value that is
* @type bool $dirty Whether or not the setting is initially dirty when created.
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 ];
$this->manager = $manager;
// Parse the ID for array keys.
$this->id_data['keys'] = preg_split( '/\[/', str_replace( ']', '', $this->id ) );
$this->id_data['base'] = array_shift( $this->id_data['keys'] );
$this->id = $this->id_data['base'];
if ( ! empty( $this->id_data['keys'] ) ) {
$this->id .= '[' . implode( '][', $this->id_data['keys'] ) . ']';
if ( $this->validate_callback ) {
add_filter( "customize_validate_{$this->id}", $this->validate_callback, 10, 3 );
if ( $this->sanitize_callback ) {
add_filter( "customize_sanitize_{$this->id}", $this->sanitize_callback, 10, 2 );
if ( $this->sanitize_js_callback ) {
add_filter( "customize_sanitize_js_{$this->id}", $this->sanitize_js_callback, 10, 2 );
if ( 'option' === $this->type || 'theme_mod' === $this->type ) {
// Other setting types can opt-in to aggregate multidimensional explicitly.
$this->aggregate_multidimensional();
// Allow option settings to indicate whether they should be autoloaded.
if ( 'option' === $this->type && isset( $args['autoload'] ) ) {
self::$aggregated_multidimensionals[ $this->type ][ $this->id_data['base'] ]['autoload'] = $args['autoload'];
* Get parsed ID data for multidimensional setting.
* ID data for multidimensional setting.
* @type string $base ID base
* @type array $keys Keys for multidimensional array.
final public function id_data() {
* Set up the setting for aggregated multidimensional values.
* When a multidimensional setting gets aggregated, all of its preview and update
* calls get combined into one call, greatly improving performance.
protected function aggregate_multidimensional() {
$id_base = $this->id_data['base'];
if ( ! isset( self::$aggregated_multidimensionals[ $this->type ] ) ) {
self::$aggregated_multidimensionals[ $this->type ] = array();
if ( ! isset( self::$aggregated_multidimensionals[ $this->type ][ $id_base ] ) ) {
self::$aggregated_multidimensionals[ $this->type ][ $id_base ] = array(
'previewed_instances' => array(), // Calling preview() will add the $setting to the array.
'preview_applied_instances' => array(), // Flags for which settings have had their values applied.
'root_value' => $this->get_root_value( array() ), // Root value for initial state, manipulated by preview and update calls.
if ( ! empty( $this->id_data['keys'] ) ) {
// Note the preview-applied flag is cleared at priority 9 to ensure it is cleared before a deferred-preview runs.
add_action( "customize_post_value_set_{$this->id}", array( $this, '_clear_aggregated_multidimensional_preview_applied_flag' ), 9 );
$this->is_multidimensional_aggregated = true;
* Reset `$aggregated_multidimensionals` static variable.
* This is intended only for use by unit tests.
public static function reset_aggregated_multidimensionals() {
self::$aggregated_multidimensionals = array();
* The ID for the current site when the preview() method was called.
protected $_previewed_blog_id;
* Return true if the current site is not the same as the previewed site.
* @return bool If preview() has been called.
public function is_current_blog_previewed() {
if ( ! isset( $this->_previewed_blog_id ) ) {
return ( get_current_blog_id() === $this->_previewed_blog_id );
* Original non-previewed value stored by the preview method.
* @see WP_Customize_Setting::preview()
protected $_original_value;
* Add filters to supply the setting's value when accessed.
* If the setting already has a pre-existing value and there is no incoming
* post value for the setting, then this method will short-circuit since
* there is no change to preview.
* @since 4.4.0 Added boolean return value.
* @return bool False when preview short-circuits due no change needing to be previewed.
public function preview() {
if ( ! isset( $this->_previewed_blog_id ) ) {
$this->_previewed_blog_id = get_current_blog_id();
// Prevent re-previewing an already-previewed setting.
if ( $this->is_previewed ) {
$id_base = $this->id_data['base'];
$is_multidimensional = ! empty( $this->id_data['keys'] );
$multidimensional_filter = array( $this, '_multidimensional_preview_filter' );
* Check if the setting has a pre-existing value (an isset check),
* and if doesn't have any incoming post value. If both checks are true,
* then the preview short-circuits because there is nothing that needs
$undefined = new stdClass();
$needs_preview = ( $undefined !== $this->post_value( $undefined ) );
// Since no post value was defined, check if we have an initial value set.
if ( ! $needs_preview ) {
if ( $this->is_multidimensional_aggregated ) {
$root = self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['root_value'];
$value = $this->multidimensional_get( $root, $this->id_data['keys'], $undefined );
$default = $this->default;
$this->default = $undefined; // Temporarily set default to undefined so we can detect if existing value is set.
$this->default = $default;
$needs_preview = ( $undefined === $value ); // Because the default needs to be supplied.
// If the setting does not need previewing now, defer to when it has a value to preview.
if ( ! $needs_preview ) {
if ( ! has_action( "customize_post_value_set_{$this->id}", array( $this, 'preview' ) ) ) {
add_action( "customize_post_value_set_{$this->id}", array( $this, 'preview' ) );
if ( ! $is_multidimensional ) {
add_filter( "theme_mod_{$id_base}", array( $this, '_preview_filter' ) );
if ( empty( self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['previewed_instances'] ) ) {
// Only add this filter once for this ID base.
add_filter( "theme_mod_{$id_base}", $multidimensional_filter );
self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['previewed_instances'][ $this->id ] = $this;
if ( ! $is_multidimensional ) {
add_filter( "pre_option_{$id_base}", array( $this, '_preview_filter' ) );
if ( empty( self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['previewed_instances'] ) ) {
// Only add these filters once for this ID base.
add_filter( "option_{$id_base}", $multidimensional_filter );
add_filter( "default_option_{$id_base}", $multidimensional_filter );
self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['previewed_instances'][ $this->id ] = $this;
* Fires when the 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.
* @param WP_Customize_Setting $setting WP_Customize_Setting instance.
do_action( "customize_preview_{$this->id}", $this );
* Fires when the 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.
* @param WP_Customize_Setting $setting WP_Customize_Setting instance.
do_action( "customize_preview_{$this->type}", $this );
$this->is_previewed = true;
* Clear out the previewed-applied flag for a multidimensional-aggregated value whenever its post value is updated.
* This ensures that the new value will get sanitized and used the next time
* that `WP_Customize_Setting::_multidimensional_preview_filter()`
* is called for this setting.
* @see WP_Customize_Manager::set_post_value()
* @see WP_Customize_Setting::_multidimensional_preview_filter()
final public function _clear_aggregated_multidimensional_preview_applied_flag() {
unset( self::$aggregated_multidimensionals[ $this->type ][ $this->id_data['base'] ]['preview_applied_instances'][ $this->id ] );
* Callback function to filter non-multidimensional theme mods and options.
* If switch_to_blog() was called after the preview() method, and the current
* site is now not the same site, then this method does a no-op and returns
* @param mixed $original Old value.
* @return mixed New or old value.
public function _preview_filter( $original ) {
if ( ! $this->is_current_blog_previewed() ) {
$undefined = new stdClass(); // Symbol hack.
$post_value = $this->post_value( $undefined );
if ( $undefined !== $post_value ) {
* Note that we don't use $original here because preview() will
* not add the filter in the first place if it has an initial value
* and there is no post value.
* Callback function to filter multidimensional theme mods and options.
* For all multidimensional settings of a given type, the preview filter for
* the first setting previewed will be used to apply the values for the others.
* @see WP_Customize_Setting::$aggregated_multidimensionals
* @param mixed $original Original root value.
* @return mixed New or old value.
final public function _multidimensional_preview_filter( $original ) {
if ( ! $this->is_current_blog_previewed() ) {
$id_base = $this->id_data['base'];
// If no settings have been previewed yet (which should not be the case, since $this is), just pass through the original value.
if ( empty( self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['previewed_instances'] ) ) {
foreach ( self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['previewed_instances'] as $previewed_setting ) {
// Skip applying previewed value for any settings that have already been applied.
if ( ! empty( self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['preview_applied_instances'][ $previewed_setting->id ] ) ) {