3 * WordPress Customize Setting classes
6 * @subpackage Customize
11 * Customize Setting class.
13 * Handles saving and sanitizing of settings.
17 * @see WP_Customize_Manager
19 class WP_Customize_Setting {
22 * @var WP_Customize_Manager
27 * Unique string identifier for the setting.
38 public $type = 'theme_mod';
41 * Capability required to edit this setting.
45 public $capability = 'edit_theme_options';
48 * Feature a theme is required to support to enable this setting.
53 public $theme_supports = '';
55 public $transport = 'refresh';
58 * Server-side sanitization callback for the setting's value.
62 public $sanitize_callback = '';
63 public $sanitize_js_callback = '';
66 * Whether or not the setting is initially dirty when created.
68 * This is used to ensure that a setting will be sent from the pane to the
69 * preview when loading the Customizer. Normally a setting only is synced to
70 * the preview if it has been changed. This allows the setting to be sent
77 public $dirty = false;
82 protected $id_data = array();
85 * Whether or not preview() was called.
91 protected $is_previewed = false;
94 * Cache of multidimensional values to improve performance.
101 protected static $aggregated_multidimensionals = array();
104 * Whether the multidimensional setting is aggregated.
110 protected $is_multidimensional_aggregated = false;
115 * Any supplied $args override class property defaults.
119 * @param WP_Customize_Manager $manager
120 * @param string $id An specific ID of the setting. Can be a
121 * theme mod or option name.
122 * @param array $args Setting arguments.
124 public function __construct( $manager, $id, $args = array() ) {
125 $keys = array_keys( get_object_vars( $this ) );
126 foreach ( $keys as $key ) {
127 if ( isset( $args[ $key ] ) ) {
128 $this->$key = $args[ $key ];
132 $this->manager = $manager;
135 // Parse the ID for array keys.
136 $this->id_data['keys'] = preg_split( '/\[/', str_replace( ']', '', $this->id ) );
137 $this->id_data['base'] = array_shift( $this->id_data['keys'] );
140 $this->id = $this->id_data[ 'base' ];
141 if ( ! empty( $this->id_data[ 'keys' ] ) ) {
142 $this->id .= '[' . implode( '][', $this->id_data['keys'] ) . ']';
145 if ( $this->sanitize_callback ) {
146 add_filter( "customize_sanitize_{$this->id}", $this->sanitize_callback, 10, 2 );
148 if ( $this->sanitize_js_callback ) {
149 add_filter( "customize_sanitize_js_{$this->id}", $this->sanitize_js_callback, 10, 2 );
152 if ( 'option' === $this->type || 'theme_mod' === $this->type ) {
153 // Other setting types can opt-in to aggregate multidimensional explicitly.
154 $this->aggregate_multidimensional();
156 // Allow option settings to indicate whether they should be autoloaded.
157 if ( 'option' === $this->type && isset( $args['autoload'] ) ) {
158 self::$aggregated_multidimensionals[ $this->type ][ $this->id_data['base'] ]['autoload'] = $args['autoload'];
164 * Get parsed ID data for multidimensional setting.
170 * ID data for multidimensional setting.
172 * @type string $base ID base
173 * @type array $keys Keys for multidimensional array.
176 final public function id_data() {
177 return $this->id_data;
181 * Set up the setting for aggregated multidimensional values.
183 * When a multidimensional setting gets aggregated, all of its preview and update
184 * calls get combined into one call, greatly improving performance.
189 protected function aggregate_multidimensional() {
190 $id_base = $this->id_data['base'];
191 if ( ! isset( self::$aggregated_multidimensionals[ $this->type ] ) ) {
192 self::$aggregated_multidimensionals[ $this->type ] = array();
194 if ( ! isset( self::$aggregated_multidimensionals[ $this->type ][ $id_base ] ) ) {
195 self::$aggregated_multidimensionals[ $this->type ][ $id_base ] = array(
196 'previewed_instances' => array(), // Calling preview() will add the $setting to the array.
197 'preview_applied_instances' => array(), // Flags for which settings have had their values applied.
198 'root_value' => $this->get_root_value( array() ), // Root value for initial state, manipulated by preview and update calls.
202 if ( ! empty( $this->id_data['keys'] ) ) {
203 // Note the preview-applied flag is cleared at priority 9 to ensure it is cleared before a deferred-preview runs.
204 add_action( "customize_post_value_set_{$this->id}", array( $this, '_clear_aggregated_multidimensional_preview_applied_flag' ), 9 );
205 $this->is_multidimensional_aggregated = true;
210 * Reset `$aggregated_multidimensionals` static variable.
212 * This is intended only for use by unit tests.
218 static public function reset_aggregated_multidimensionals() {
219 self::$aggregated_multidimensionals = array();
223 * The ID for the current site when the preview() method was called.
229 protected $_previewed_blog_id;
232 * Return true if the current site is not the same as the previewed site.
237 * @return bool If preview() has been called.
239 public function is_current_blog_previewed() {
240 if ( ! isset( $this->_previewed_blog_id ) ) {
243 return ( get_current_blog_id() === $this->_previewed_blog_id );
247 * Original non-previewed value stored by the preview method.
249 * @see WP_Customize_Setting::preview()
253 protected $_original_value;
256 * Add filters to supply the setting's value when accessed.
258 * If the setting already has a pre-existing value and there is no incoming
259 * post value for the setting, then this method will short-circuit since
260 * there is no change to preview.
263 * @since 4.4.0 Added boolean return value.
266 * @return bool False when preview short-circuits due no change needing to be previewed.
268 public function preview() {
269 if ( ! isset( $this->_previewed_blog_id ) ) {
270 $this->_previewed_blog_id = get_current_blog_id();
273 // Prevent re-previewing an already-previewed setting.
274 if ( $this->is_previewed ) {
278 $id_base = $this->id_data['base'];
279 $is_multidimensional = ! empty( $this->id_data['keys'] );
280 $multidimensional_filter = array( $this, '_multidimensional_preview_filter' );
283 * Check if the setting has a pre-existing value (an isset check),
284 * and if doesn't have any incoming post value. If both checks are true,
285 * then the preview short-circuits because there is nothing that needs
288 $undefined = new stdClass();
289 $needs_preview = ( $undefined !== $this->post_value( $undefined ) );
292 // Since no post value was defined, check if we have an initial value set.
293 if ( ! $needs_preview ) {
294 if ( $this->is_multidimensional_aggregated ) {
295 $root = self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['root_value'];
296 $value = $this->multidimensional_get( $root, $this->id_data['keys'], $undefined );
298 $default = $this->default;
299 $this->default = $undefined; // Temporarily set default to undefined so we can detect if existing value is set.
300 $value = $this->value();
301 $this->default = $default;
303 $needs_preview = ( $undefined === $value ); // Because the default needs to be supplied.
306 // If the setting does not need previewing now, defer to when it has a value to preview.
307 if ( ! $needs_preview ) {
308 if ( ! has_action( "customize_post_value_set_{$this->id}", array( $this, 'preview' ) ) ) {
309 add_action( "customize_post_value_set_{$this->id}", array( $this, 'preview' ) );
314 switch ( $this->type ) {
316 if ( ! $is_multidimensional ) {
317 add_filter( "theme_mod_{$id_base}", array( $this, '_preview_filter' ) );
319 if ( empty( self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['previewed_instances'] ) ) {
320 // Only add this filter once for this ID base.
321 add_filter( "theme_mod_{$id_base}", $multidimensional_filter );
323 self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['previewed_instances'][ $this->id ] = $this;
327 if ( ! $is_multidimensional ) {
328 add_filter( "pre_option_{$id_base}", array( $this, '_preview_filter' ) );
330 if ( empty( self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['previewed_instances'] ) ) {
331 // Only add these filters once for this ID base.
332 add_filter( "option_{$id_base}", $multidimensional_filter );
333 add_filter( "default_option_{$id_base}", $multidimensional_filter );
335 self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['previewed_instances'][ $this->id ] = $this;
341 * Fires when the {@see WP_Customize_Setting::preview()} method is called for settings
342 * not handled as theme_mods or options.
344 * The dynamic portion of the hook name, `$this->id`, refers to the setting ID.
348 * @param WP_Customize_Setting $this {@see WP_Customize_Setting} instance.
350 do_action( "customize_preview_{$this->id}", $this );
353 * Fires when the {@see WP_Customize_Setting::preview()} method is called for settings
354 * not handled as theme_mods or options.
356 * The dynamic portion of the hook name, `$this->type`, refers to the setting type.
360 * @param WP_Customize_Setting $this {@see WP_Customize_Setting} instance.
362 do_action( "customize_preview_{$this->type}", $this );
365 $this->is_previewed = true;
371 * Clear out the previewed-applied flag for a multidimensional-aggregated value whenever its post value is updated.
373 * This ensures that the new value will get sanitized and used the next time
374 * that `WP_Customize_Setting::_multidimensional_preview_filter()`
375 * is called for this setting.
379 * @see WP_Customize_Manager::set_post_value()
380 * @see WP_Customize_Setting::_multidimensional_preview_filter()
382 final public function _clear_aggregated_multidimensional_preview_applied_flag() {
383 unset( self::$aggregated_multidimensionals[ $this->type ][ $this->id_data['base'] ]['preview_applied_instances'][ $this->id ] );
387 * Callback function to filter non-multidimensional theme mods and options.
389 * If switch_to_blog() was called after the preview() method, and the current
390 * site is now not the same site, then this method does a no-op and returns
391 * the original value.
395 * @param mixed $original Old value.
396 * @return mixed New or old value.
398 public function _preview_filter( $original ) {
399 if ( ! $this->is_current_blog_previewed() ) {
403 $undefined = new stdClass(); // Symbol hack.
404 $post_value = $this->post_value( $undefined );
405 if ( $undefined !== $post_value ) {
406 $value = $post_value;
409 * Note that we don't use $original here because preview() will
410 * not add the filter in the first place if it has an initial value
411 * and there is no post value.
413 $value = $this->default;
419 * Callback function to filter multidimensional theme mods and options.
421 * For all multidimensional settings of a given type, the preview filter for
422 * the first setting previewed will be used to apply the values for the others.
427 * @see WP_Customize_Setting::$aggregated_multidimensionals
428 * @param mixed $original Original root value.
429 * @return mixed New or old value.
431 final public function _multidimensional_preview_filter( $original ) {
432 if ( ! $this->is_current_blog_previewed() ) {
436 $id_base = $this->id_data['base'];
438 // If no settings have been previewed yet (which should not be the case, since $this is), just pass through the original value.
439 if ( empty( self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['previewed_instances'] ) ) {
443 foreach ( self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['previewed_instances'] as $previewed_setting ) {
444 // Skip applying previewed value for any settings that have already been applied.
445 if ( ! empty( self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['preview_applied_instances'][ $previewed_setting->id ] ) ) {
449 // Do the replacements of the posted/default sub value into the root value.
450 $value = $previewed_setting->post_value( $previewed_setting->default );
451 $root = self::$aggregated_multidimensionals[ $previewed_setting->type ][ $id_base ]['root_value'];
452 $root = $previewed_setting->multidimensional_replace( $root, $previewed_setting->id_data['keys'], $value );
453 self::$aggregated_multidimensionals[ $previewed_setting->type ][ $id_base ]['root_value'] = $root;
455 // Mark this setting having been applied so that it will be skipped when the filter is called again.
456 self::$aggregated_multidimensionals[ $previewed_setting->type ][ $id_base ]['preview_applied_instances'][ $previewed_setting->id ] = true;
459 return self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['root_value'];
463 * Check user capabilities and theme supports, and then save
464 * the value of the setting.
468 * @return false|void False if cap check fails or value isn't set.
470 final public function save() {
471 $value = $this->post_value();
473 if ( ! $this->check_capabilities() || ! isset( $value ) )
477 * Fires when the WP_Customize_Setting::save() method is called.
479 * The dynamic portion of the hook name, `$this->id_data['base']` refers to
480 * the base slug of the setting name.
484 * @param WP_Customize_Setting $this {@see WP_Customize_Setting} instance.
486 do_action( 'customize_save_' . $this->id_data[ 'base' ], $this );
488 $this->update( $value );
492 * Fetch and sanitize the $_POST value for the setting.
496 * @param mixed $default A default value which is used as a fallback. Default is null.
497 * @return mixed The default value on failure, otherwise the sanitized value.
499 final public function post_value( $default = null ) {
500 return $this->manager->post_value( $this, $default );
508 * @param string|array $value The value to sanitize.
509 * @return string|array|null Null if an input isn't valid, otherwise the sanitized value.
511 public function sanitize( $value ) {
514 * Filter a Customize setting value in un-slashed form.
518 * @param mixed $value Value of the setting.
519 * @param WP_Customize_Setting $this WP_Customize_Setting instance.
521 return apply_filters( "customize_sanitize_{$this->id}", $value, $this );
525 * Get the root value for a setting, especially for multidimensional ones.
530 * @param mixed $default Value to return if root does not exist.
533 protected function get_root_value( $default = null ) {
534 $id_base = $this->id_data['base'];
535 if ( 'option' === $this->type ) {
536 return get_option( $id_base, $default );
537 } else if ( 'theme_mod' ) {
538 return get_theme_mod( $id_base, $default );
541 * Any WP_Customize_Setting subclass implementing aggregate multidimensional
542 * will need to override this method to obtain the data from the appropriate
550 * Set the root value for a setting, especially for multidimensional ones.
555 * @param mixed $value Value to set as root of multidimensional setting.
556 * @return bool Whether the multidimensional root was updated successfully.
558 protected function set_root_value( $value ) {
559 $id_base = $this->id_data['base'];
560 if ( 'option' === $this->type ) {
562 if ( isset( self::$aggregated_multidimensionals[ $this->type ][ $this->id_data['base'] ]['autoload'] ) ) {
563 $autoload = self::$aggregated_multidimensionals[ $this->type ][ $this->id_data['base'] ]['autoload'];
565 return update_option( $id_base, $value, $autoload );
566 } else if ( 'theme_mod' ) {
567 set_theme_mod( $id_base, $value );
571 * Any WP_Customize_Setting subclass implementing aggregate multidimensional
572 * will need to override this method to obtain the data from the appropriate
580 * Save the value of the setting, using the related API.
584 * @param mixed $value The value to update.
585 * @return bool The result of saving the value.
587 protected function update( $value ) {
588 $id_base = $this->id_data['base'];
589 if ( 'option' === $this->type || 'theme_mod' === $this->type ) {
590 if ( ! $this->is_multidimensional_aggregated ) {
591 return $this->set_root_value( $value );
593 $root = self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['root_value'];
594 $root = $this->multidimensional_replace( $root, $this->id_data['keys'], $value );
595 self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['root_value'] = $root;
596 return $this->set_root_value( $root );
600 * Fires when the {@see WP_Customize_Setting::update()} method is called for settings
601 * not handled as theme_mods or options.
603 * The dynamic portion of the hook name, `$this->type`, refers to the type of setting.
607 * @param mixed $value Value of the setting.
608 * @param WP_Customize_Setting $this WP_Customize_Setting instance.
610 do_action( "customize_update_{$this->type}", $value, $this );
612 return has_action( "customize_update_{$this->type}" );
620 * @deprecated 4.4.0 Deprecated in favor of update() method.
622 protected function _update_theme_mod() {
623 _deprecated_function( __METHOD__, '4.4.0', __CLASS__ . '::update()' );
630 * @deprecated 4.4.0 Deprecated in favor of update() method.
632 protected function _update_option() {
633 _deprecated_function( __METHOD__, '4.4.0', __CLASS__ . '::update()' );
637 * Fetch the value of the setting.
641 * @return mixed The value.
643 public function value() {
644 $id_base = $this->id_data['base'];
645 $is_core_type = ( 'option' === $this->type || 'theme_mod' === $this->type );
647 if ( ! $is_core_type && ! $this->is_multidimensional_aggregated ) {
648 $value = $this->get_root_value( $this->default );
651 * Filter a Customize setting value not handled as a theme_mod or option.
653 * The dynamic portion of the hook name, `$this->id_date['base']`, refers to
654 * the base slug of the setting name.
656 * For settings handled as theme_mods or options, see those corresponding
657 * functions for available hooks.
661 * @param mixed $default The setting default value. Default empty.
663 $value = apply_filters( "customize_value_{$id_base}", $value );
664 } else if ( $this->is_multidimensional_aggregated ) {
665 $root_value = self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['root_value'];
666 $value = $this->multidimensional_get( $root_value, $this->id_data['keys'], $this->default );
668 $value = $this->get_root_value( $this->default );
674 * Sanitize the setting's value for use in JavaScript.
678 * @return mixed The requested escaped value.
680 public function js_value() {
683 * Filter a Customize setting value for use in JavaScript.
685 * The dynamic portion of the hook name, `$this->id`, refers to the setting ID.
689 * @param mixed $value The setting value.
690 * @param WP_Customize_Setting $this {@see WP_Customize_Setting} instance.
692 $value = apply_filters( "customize_sanitize_js_{$this->id}", $this->value(), $this );
694 if ( is_string( $value ) )
695 return html_entity_decode( $value, ENT_QUOTES, 'UTF-8');
701 * Validate user capabilities whether the theme supports the setting.
705 * @return bool False if theme doesn't support the setting or user can't change setting, otherwise true.
707 final public function check_capabilities() {
708 if ( $this->capability && ! call_user_func_array( 'current_user_can', (array) $this->capability ) )
711 if ( $this->theme_supports && ! call_user_func_array( 'current_theme_supports', (array) $this->theme_supports ) )
718 * Multidimensional helper function.
724 * @param bool $create Default is false.
725 * @return array|void Keys are 'root', 'node', and 'key'.
727 final protected function multidimensional( &$root, $keys, $create = false ) {
728 if ( $create && empty( $root ) )
731 if ( ! isset( $root ) || empty( $keys ) )
734 $last = array_pop( $keys );
737 foreach ( $keys as $key ) {
738 if ( $create && ! isset( $node[ $key ] ) )
739 $node[ $key ] = array();
741 if ( ! is_array( $node ) || ! isset( $node[ $key ] ) )
744 $node = &$node[ $key ];
748 if ( ! is_array( $node ) ) {
749 // account for an array overriding a string or object value
752 if ( ! isset( $node[ $last ] ) ) {
753 $node[ $last ] = array();
757 if ( ! isset( $node[ $last ] ) )
768 * Will attempt to replace a specific value in a multidimensional array.
774 * @param mixed $value The value to update.
777 final protected function multidimensional_replace( $root, $keys, $value ) {
778 if ( ! isset( $value ) )
780 elseif ( empty( $keys ) ) // If there are no keys, we're replacing the root.
783 $result = $this->multidimensional( $root, $keys, true );
785 if ( isset( $result ) )
786 $result['node'][ $result['key'] ] = $value;
792 * Will attempt to fetch a specific value from a multidimensional array.
798 * @param mixed $default A default value which is used as a fallback. Default is null.
799 * @return mixed The requested value or the default value.
801 final protected function multidimensional_get( $root, $keys, $default = null ) {
802 if ( empty( $keys ) ) // If there are no keys, test the root.
803 return isset( $root ) ? $root : $default;
805 $result = $this->multidimensional( $root, $keys );
806 return isset( $result ) ? $result['node'][ $result['key'] ] : $default;
810 * Will attempt to check if a specific value in a multidimensional array is set.
816 * @return bool True if value is set, false if not.
818 final protected function multidimensional_isset( $root, $keys ) {
819 $result = $this->multidimensional_get( $root, $keys );
820 return isset( $result );
824 /** WP_Customize_Filter_Setting class */
825 require_once( ABSPATH . WPINC . '/customize/class-wp-customize-filter-setting.php' );
827 /** WP_Customize_Header_Image_Setting class */
828 require_once( ABSPATH . WPINC . '/customize/class-wp-customize-header-image-setting.php' );
830 /** WP_Customize_Background_Image_Setting class */
831 require_once( ABSPATH . WPINC . '/customize/class-wp-customize-background-image-setting.php' );
833 /** WP_Customize_Nav_Menu_Item_Setting class */
834 require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-item-setting.php' );
836 /** WP_Customize_Nav_Menu_Setting class */
837 require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-setting.php' );