- md5
- 142b6beb657bba155f9242902577fb93
- sha1
- ec8e78c42ac47eeab2d6bb163c7b3a8ba18f985b
- sha256
- 9008c98140d1e10992fd0d04a67de1e2e78ee9c681f08477baf6675689437bbf
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177
<?php
/**
* 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 {
/**
* Customizer bootstrap instance.
*
* @since 3.4.0
* @var WP_Customize_Manager
*/
public $manager;
/**
* Unique string identifier for the setting.
*
* @since 3.4.0
* @var string
*/
public $id;
/**
* Type of customize settings.
*
* @since 3.4.0
* @var string
*/
public $type = 'theme_mod';
/**
* Capability required to edit this setting.
*
* @since 3.4.0
* @var string|array
*/
public $capability = 'edit_theme_options';
/**
* Feature a theme is required to support to enable this setting.
*
* @since 3.4.0
* @var string
*/
public $theme_supports = '';
/**
* The default value for the setting.
*
* @since 3.4.0
* @var string
*/
public $default = '';
/**
* Options for rendering the live preview of changes in Theme 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.
*
* @link https://developer.wordpress.org/themes/customize-api
*
* @since 3.4.0
* @var string
*/
public $transport = 'refresh';
/**
* Server-side validation callback for the setting's value.
*
* @since 4.6.0
* @var callable
*/
public $validate_callback = '';
/**
* Callback to filter a Customize setting value in un-slashed form.
*
* @since 3.4.0
* @var callable
*/
public $sanitize_callback = '';
/**
* Callback to convert a Customize PHP setting value to a value that is JSON serializable.
*
* @since 3.4.0
* @var string
*/
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
* from the start.
*
* @since 4.2.0
* @var bool
*/
public $dirty = false;
/**
* ID Data.
*
* @since 3.4.0
* @var array
*/
protected $id_data = array();
/**
* Whether or not preview() was called.
*
* @since 4.4.0
* @var bool
*/
protected $is_previewed = false;
/**
* Cache of multidimensional values to improve performance.
*
* @since 4.4.0
* @static
* @var array
*/
protected static $aggregated_multidimensionals = array();
/**
* Whether the multidimensional setting is aggregated.
*
* @since 4.4.0
* @var bool
*/
protected $is_multidimensional_aggregated = false;
/**
* Whether the setting is being saved.
*
* When saving, the value of an option setting is not sanitized with `sanitize_option()`
* by {@see WP_Customize_Setting::sanitize()} since `update_option()` sanitizes it.
*
* @since 7.1.5
* @var bool
*/
private $is_saving = false;
/**
* Number of times that previewing has been suspended for each option, keyed by option name.
*
* While previewing an option is suspended, its preview filters pass through the original value.
*
* @since 7.1.5
* @see WP_Customize_Setting::suspend_option_preview()
* @var array<string, positive-int>
*/
private static $suspended_option_previews = array();
/**
* Constructor.
*
* Any supplied $args override class property defaults.
*
* @since 3.4.0
*
* @param WP_Customize_Manager $manager
* @param string $id An specific ID of the setting. Can be a
* theme mod or option name.
* @param array $args Setting arguments.
*/
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;
$this->id = $id;
// 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'] );
// Rebuild the ID.
$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.
*
* @since 4.4.0
*
* @return array {
* ID data for multidimensional setting.
*
* @type string $base ID base
* @type array $keys Keys for multidimensional array.
* }
*/
final public function id_data() {
return $this->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.
*
* @since 4.4.0
*/
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.
*
* @since 4.5.0
* @ignore
*/
static public function reset_aggregated_multidimensionals() {
self::$aggregated_multidimensionals = array();
}
/**
* The ID for the current site when the preview() method was called.
*
* @since 4.2.0
* @var int
*/
protected $_previewed_blog_id;
/**
* Return true if the current site is not the same as the previewed site.
*
* @since 4.2.0
*
* @return bool If preview() has been called.
*/
public function is_current_blog_previewed() {
if ( ! isset( $this->_previewed_blog_id ) ) {
return false;
}
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;
/**
* 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 3.4.0
* @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 ) {
return true;
}
$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
* to be previewed.
*/
$undefined = new stdClass();
$needs_preview = ( $undefined !== $this->post_value( $undefined ) );
$value = null;
// 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 );
} else {
$default = $this->default;
$this->default = $undefined; // Temporarily set default to undefined so we can detect if existing value is set.
$value = $this->value();
$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' ) );
}
return false;
}
switch ( $this->type ) {
case 'theme_mod' :
if ( ! $is_multidimensional ) {
add_filter( "theme_mod_{$id_base}", array( $this, '_preview_filter' ) );
} else {
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;
}
break;
case 'option' :
if ( ! $is_multidimensional ) {
add_filter( "pre_option_{$id_base}", array( $this, '_preview_filter' ) );
} else {
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;
}
break;
default :
/**
* 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.
*
* @since 3.4.0
*
* @param WP_Customize_Setting $this 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.
*
* @since 4.1.0
*
* @param WP_Customize_Setting $this WP_Customize_Setting instance.
*/
do_action( "customize_preview_{$this->type}", $this );
}
$this->is_previewed = true;
return 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.
*
* @since 4.4.0
*
* @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 ] );
}
/**
* Suspends previewing the setting's option, so that its preview filters pass through the original value.
*
* This is done while the option is being sanitized or saved. Every call must be paired with a call to
* {@see WP_Customize_Setting::resume_option_preview()}, including when an exception or error is thrown.
*
* @since 7.1.5
*/
private function suspend_option_preview() {
/** @var string $id_base */
$id_base = $this->id_data['base'];
if ( ! isset( self::$suspended_option_previews[ $id_base ] ) ) {
self::$suspended_option_previews[ $id_base ] = 1;
} else {
++self::$suspended_option_previews[ $id_base ];
}
}
/**
* Resumes previewing the setting's option, once each suspension has been resumed.
*
* @since 7.1.5
*
* @see WP_Customize_Setting::suspend_option_preview()
*/
private function resume_option_preview() {
/** @var string $id_base */
$id_base = $this->id_data['base'];
if ( ! isset( self::$suspended_option_previews[ $id_base ] ) ) {
return;
}
if ( self::$suspended_option_previews[ $id_base ] > 1 ) {
--self::$suspended_option_previews[ $id_base ];
} else {
unset( self::$suspended_option_previews[ $id_base ] );
}
}
/**
* Determines whether previewing the setting's option is suspended.
*
* @since 7.1.5
*
* @see WP_Customize_Setting::suspend_option_preview()
*
* @return bool Whether previewing the option is suspended.
*/
private function is_option_preview_suspended() {
/** @var string $id_base */
$id_base = $this->id_data['base'];
return 'option' === $this->type && isset( self::$suspended_option_previews[ $id_base ] );
}
/**
* 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
* the original value.
*
* @since 3.4.0
*
* @param mixed $original Old value.
* @return mixed New or old value.
*/
public function _preview_filter( $original ) {
if ( ! $this->is_current_blog_previewed() || $this->is_option_preview_suspended() ) {
return $original;
}
$undefined = new stdClass(); // Symbol hack.
$post_value = $this->post_value( $undefined );
if ( $undefined !== $post_value ) {
$value = $post_value;
} else {
/*
* 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.
*/
$value = $this->default;
}
return $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.
*
* @since 4.4.0
*
* @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() || $this->is_option_preview_suspended() ) {
return $original;
}
$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'] ) ) {
return $original;
}
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 ] ) ) {
continue;
}
// Do the replacements of the posted/default sub value into the root value.
$value = $previewed_setting->post_value( $previewed_setting->default );
$root = self::$aggregated_multidimensionals[ $previewed_setting->type ][ $id_base ]['root_value'];
$root = $previewed_setting->multidimensional_replace( $root, $previewed_setting->id_data['keys'], $value );
self::$aggregated_multidimensionals[ $previewed_setting->type ][ $id_base ]['root_value'] = $root;
// Mark this setting having been applied so that it will be skipped when the filter is called again.
self::$aggregated_multidimensionals[ $previewed_setting->type ][ $id_base ]['preview_applied_instances'][ $previewed_setting->id ] = true;
}
return self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['root_value'];
}
/**
* Checks user capabilities and theme supports, and then saves
* the value of the setting.
*
* @since 3.4.0
*
* @return false|void False if cap check fails or value isn't set or is invalid.
*/
final public function save() {
/*
* While saving an option setting, its preview filters pass through the persisted value. Otherwise,
* update_option() would skip the update when the new value is the same as the previewed value, and
* hooks which read the option while saving would get a value not sanitized with sanitize_option().
*/
if ( 'option' === $this->type ) {
$this->suspend_option_preview();
}
/*
* Since a `finally` block requires PHP 5.5, the state is restored in each `catch` block before
* rethrowing. Exceptions are caught for PHP 5, and errors such as TypeError for PHP 7+.
*/
try {
$this->is_saving = true;
$value = $this->post_value();
$this->is_saving = false;
if ( ! $this->check_capabilities() || ! isset( $value ) ) {
$this->end_saving();
return false;
}
/** @var string $id_base */
$id_base = $this->id_data['base'];
/**
* Fires when the WP_Customize_Setting::save() method is called.
*
* The dynamic portion of the hook name, `$id_base` refers to
* the base slug of the setting name.
*
* @since 3.4.0
*
* @param WP_Customize_Setting $this WP_Customize_Setting instance.
*/
do_action( "customize_save_{$id_base}", $this );
$this->update( $value );
} catch ( Exception $e ) {
$this->end_saving();
throw $e;
} catch ( Throwable $e ) {
$this->end_saving();
throw $e;
}
$this->end_saving();
}
/**
* Restores the state changed while saving the setting.
*
* @since 7.1.5
*
* @see WP_Customize_Setting::save()
*/
private function end_saving() {
$this->is_saving = false;
if ( 'option' === $this->type ) {
$this->resume_option_preview();
}
}
/**
* Fetch and sanitize the $_POST value for the setting.
*
* During a save request prior to save, post_value() provides the new value while value() does not.
*
* @since 3.4.0
*
* @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 and validated value.
*/
final public function post_value( $default = null ) {
return $this->manager->post_value( $this, $default );
}
/**
* Sanitize an input.
*
* @since 3.4.0
* @since 7.1.5 The value of an option setting is additionally sanitized with `sanitize_option()`.
*
* @param string|array $value The value to sanitize.
* @return string|array|null|WP_Error Sanitized value, or `null`/`WP_Error` if invalid.
*/
public function sanitize( $value ) {
/**
* Filters a Customize setting value in un-slashed form.
*
* @since 3.4.0
*
* @param mixed $value Value of the setting.
* @param WP_Customize_Setting $this WP_Customize_Setting instance.
*/
$value = apply_filters( "customize_sanitize_{$this->id}", $value, $this );
/*
* The value of an option setting is previewed via the option filters, bypassing the
* sanitize_option() call in update_option(). So the value is sanitized here to ensure
* that the previewed value is sanitized in the same way as the value which would be
* persisted. When saving, this is skipped since update_option() sanitizes the value.
*/
if ( 'option' === $this->type && ! $this->is_saving && ! is_null( $value ) && ! is_wp_error( $value ) ) {
$value = $this->sanitize_option_value( $value );
}
return $value;
}
/**
* Sanitizes the value of an option setting with `sanitize_option()`.
*
* This applies the sanitization for core options as well as for options sanitized via the
* {@see 'sanitize_option_$option'} filter, such as by the `sanitize_callback` passed to
* `register_setting()`. The value of a multidimensional setting is sanitized as part of
* the root option value.
*
* Any errors added via `add_settings_error()` during sanitization are returned as a `WP_Error`.
*
* @since 7.1.5
*
* @global array<int, array{setting: string, code: string, message: string, type: string}>|null $wp_settings_errors Storage array of errors registered during this pageload.
*
* @param mixed $value Value which has already been sanitized by the setting's sanitize callback.
* @return mixed|WP_Error Sanitized value, or `WP_Error` if invalid.
*/
private function sanitize_option_value( $value ) {
global $wp_settings_errors;
/** @var string $id_base */
$id_base = $this->id_data['base'];
/** @var string[] $keys */
$keys = $this->id_data['keys'];
// Callbacks for the "sanitize_option_{$option}" filter may call add_settings_error() without checking whether it exists.
if ( ! function_exists( 'add_settings_error' ) ) {
require_once ABSPATH . 'wp-admin/includes/template.php';
}
if ( $this->is_multidimensional_aggregated ) {
$root = self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['root_value'];
$value = $this->multidimensional_replace( $root, $keys, $value );
}
// Capture only the errors added while sanitizing, and leave the existing errors untouched.
$previous_settings_errors = $wp_settings_errors;
$previous_settings_errors_count = is_array( $wp_settings_errors ) ? count( $wp_settings_errors ) : 0;
/*
* While sanitizing, the preview filters for the option pass through the original value. This
* prevents infinite recursion when sanitize_option() calls get_option() for the same option,
* for example to fall back to the existing value when the value is invalid.
*
* Since a `finally` block requires PHP 5.5, the state is restored in each `catch` block before
* rethrowing. Exceptions are caught for PHP 5, and errors such as TypeError for PHP 7+.
*/
$this->suspend_option_preview();
try {
$value = sanitize_option( $id_base, $value );
} catch ( Exception $e ) {
$this->resume_option_preview();
$wp_settings_errors = $previous_settings_errors;
throw $e;
} catch ( Throwable $e ) {
$this->resume_option_preview();
$wp_settings_errors = $previous_settings_errors;
throw $e;
}
$this->resume_option_preview();
$settings_errors = is_array( $wp_settings_errors ) ? array_slice( $wp_settings_errors, $previous_settings_errors_count ) : array();
$wp_settings_errors = $previous_settings_errors;
$validity = new WP_Error();
foreach ( $settings_errors as $settings_error ) {
if ( 'error' === $settings_error['type'] ) {
$validity->add( $settings_error['code'], $settings_error['message'] );
}
}
if ( array() !== $validity->get_error_codes() ) {
return $validity;
}
if ( $this->is_multidimensional_aggregated ) {
$value = $this->multidimensional_get( $value, $keys );
}
return $value;
}
/**
* Validates an input.
*
* @since 4.6.0
*
* @see WP_REST_Request::has_valid_params()
*
* @param mixed $value Value to validate.
* @return true|WP_Error True if the input was validated, otherwise WP_Error.
*/
public function validate( $value ) {
if ( is_wp_error( $value ) ) {
return $value;
}
if ( is_null( $value ) ) {
return new WP_Error( 'invalid_value', __( 'Invalid value.' ) );
}
$validity = new WP_Error();
/**
* Validates a Customize setting value.
*
* Plugins should amend the `$validity` object via its `WP_Error::add()` method.
*
* The dynamic portion of the hook name, `$this->ID`, refers to the setting ID.
*
* @since 4.6.0
*
* @param WP_Error $validity Filtered from `true` to `WP_Error` when invalid.
* @param mixed $value Value of the setting.
* @param WP_Customize_Setting $this WP_Customize_Setting instance.
*/
$validity = apply_filters( "customize_validate_{$this->id}", $validity, $value, $this );
if ( is_wp_error( $validity ) && empty( $validity->errors ) ) {
$validity = true;
}
return $validity;
}
/**
* Get the root value for a setting, especially for multidimensional ones.
*
* @since 4.4.0
*
* @param mixed $default Value to return if root does not exist.
* @return mixed
*/
protected function get_root_value( $default = null ) {
$id_base = $this->id_data['base'];
if ( 'option' === $this->type ) {
return get_option( $id_base, $default );
} elseif ( 'theme_mod' === $this->type ) {
return get_theme_mod( $id_base, $default );
} else {
/*
* Any WP_Customize_Setting subclass implementing aggregate multidimensional
* will need to override this method to obtain the data from the appropriate
* location.
*/
return $default;
}
}
/**
* Set the root value for a setting, especially for multidimensional ones.
*
* @since 4.4.0
*
* @param mixed $value Value to set as root of multidimensional setting.
* @return bool Whether the multidimensional root was updated successfully.
*/
protected function set_root_value( $value ) {
$id_base = $this->id_data['base'];
if ( 'option' === $this->type ) {
$autoload = true;
if ( isset( self::$aggregated_multidimensionals[ $this->type ][ $this->id_data['base'] ]['autoload'] ) ) {
$autoload = self::$aggregated_multidimensionals[ $this->type ][ $this->id_data['base'] ]['autoload'];
}
return update_option( $id_base, $value, $autoload );
} elseif ( 'theme_mod' === $this->type ) {
set_theme_mod( $id_base, $value );
return true;
} else {
/*
* Any WP_Customize_Setting subclass implementing aggregate multidimensional
* will need to override this method to obtain the data from the appropriate
* location.
*/
return false;
}
}
/**
* Save the value of the setting, using the related API.
*
* @since 3.4.0
*
* @param mixed $value The value to update.
* @return bool The result of saving the value.
*/
protected function update( $value ) {
$id_base = $this->id_data['base'];
if ( 'option' === $this->type || 'theme_mod' === $this->type ) {
if ( ! $this->is_multidimensional_aggregated ) {
return $this->set_root_value( $value );
} else {
$root = self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['root_value'];
$root = $this->multidimensional_replace( $root, $this->id_data['keys'], $value );
self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['root_value'] = $root;
return $this->set_root_value( $root );
}
} else {
/**
* Fires when the 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.
*
* @since 3.4.0
*
* @param mixed $value Value of the setting.
* @param WP_Customize_Setting $this WP_Customize_Setting instance.
*/
do_action( "customize_update_{$this->type}", $value, $this );
return has_action( "customize_update_{$this->type}" );
}
}
/**
* Deprecated method.
*
* @since 3.4.0
* @deprecated 4.4.0 Deprecated in favor of update() method.
*/
protected function _update_theme_mod() {
_deprecated_function( __METHOD__, '4.4.0', __CLASS__ . '::update()' );
}
/**
* Deprecated method.
*
* @since 3.4.0
* @deprecated 4.4.0 Deprecated in favor of update() method.
*/
protected function _update_option() {
_deprecated_function( __METHOD__, '4.4.0', __CLASS__ . '::update()' );
}
/**
* Fetch the value of the setting.
*
* @since 3.4.0
*
* @return mixed The value.
*/
public function value() {
$id_base = $this->id_data['base'];
$is_core_type = ( 'option' === $this->type || 'theme_mod' === $this->type );
if ( ! $is_core_type && ! $this->is_multidimensional_aggregated ) {
// Use post value if previewed and a post value is present.
if ( $this->is_previewed ) {
$value = $this->post_value( null );
if ( null !== $value ) {
return $value;
}
}
$value = $this->get_root_value( $this->default );
/**
* Filters a Customize setting value not handled as a theme_mod or option.
*
* The dynamic portion of the hook name, `$id_base`, refers to
* the base slug of the setting name, initialized from `$this->id_data['base']`.
*
* For settings handled as theme_mods or options, see those corresponding
* functions for available hooks.
*
* @since 3.4.0
* @since 4.6.0 Added the `$this` setting instance as the second parameter.
*
* @param mixed $default The setting default value. Default empty.
* @param WP_Customize_Setting $this The setting instance.
*/
$value = apply_filters( "customize_value_{$id_base}", $value, $this );
} elseif ( $this->is_multidimensional_aggregated ) {
$root_value = self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['root_value'];
$value = $this->multidimensional_get( $root_value, $this->id_data['keys'], $this->default );
// Ensure that the post value is used if the setting is previewed, since preview filters aren't applying on cached $root_value.
if ( $this->is_previewed ) {
$value = $this->post_value( $value );
}
} else {
$value = $this->get_root_value( $this->default );
}
return $value;
}
/**
* Sanitize the setting's value for use in JavaScript.
*
* @since 3.4.0
*
* @return mixed The requested escaped value.
*/
public function js_value() {
/**
* Filters a Customize setting value for use in JavaScript.
*
* 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.
*/
$value = apply_filters( "customize_sanitize_js_{$this->id}", $this->value(), $this );
if ( is_string( $value ) )
return html_entity_decode( $value, ENT_QUOTES, 'UTF-8');
return $value;
}
/**
* Retrieves the data to export to the client via JSON.
*
* @since 4.6.0
*
* @return array Array of parameters passed to JavaScript.
*/
public function json() {
return array(
'value' => $this->js_value(),
'transport' => $this->transport,
'dirty' => $this->dirty,
'type' => $this->type,
);
}
/**
* Validate user capabilities whether the theme supports the setting.
*
* @since 3.4.0
*
* @return bool False if theme doesn't support the setting or user can't change setting, otherwise true.
*/
final public function check_capabilities() {
if ( $this->capability && ! call_user_func_array( 'current_user_can', (array) $this->capability ) )
return false;
if ( $this->theme_supports && ! call_user_func_array( 'current_theme_supports', (array) $this->theme_supports ) )
return false;
return true;
}
/**
* Multidimensional helper function.
*
* @since 3.4.0
* @since 7.1.5 When creating, a non-array value is overridden with an array at every level, not only the last.
*
* @param $root
* @param $keys
* @param bool $create Default is false.
* @return array|void Keys are 'root', 'node', and 'key'.
*/
final protected function multidimensional( &$root, $keys, $create = false ) {
if ( $create && empty( $root ) )
$root = array();
if ( ! isset( $root ) || empty( $keys ) )
return;
$last = array_pop( $keys );
$node = &$root;
foreach ( $keys as $key ) {
if ( $create && ! is_array( $node ) ) {
// Account for an array overriding a string or object value.
$node = array();
}
if ( $create && ! isset( $node[ $key ] ) )
$node[ $key ] = array();
if ( ! is_array( $node ) || ! isset( $node[ $key ] ) )
return;
$node = &$node[ $key ];
}
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;
return array(
'root' => &$root,
'node' => &$node,
'key' => $last,
);
}
/**
* Will attempt to replace a specific value in a multidimensional array.
*
* @since 3.4.0
*
* @param $root
* @param $keys
* @param mixed $value The value to update.
* @return mixed
*/
final protected function multidimensional_replace( $root, $keys, $value ) {
if ( ! isset( $value ) )
return $root;
elseif ( empty( $keys ) ) // If there are no keys, we're replacing the root.
return $value;
$result = $this->multidimensional( $root, $keys, true );
if ( isset( $result ) )
$result['node'][ $result['key'] ] = $value;
return $root;
}
/**
* Will attempt to fetch a specific value from a multidimensional array.
*
* @since 3.4.0
*
* @param $root
* @param $keys
* @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 ) {
if ( empty( $keys ) ) // If there are no keys, test the root.
return isset( $root ) ? $root : $default;
$result = $this->multidimensional( $root, $keys );
return isset( $result ) ? $result['node'][ $result['key'] ] : $default;
}
/**
* Will attempt to check if a specific value in a multidimensional array is set.
*
* @since 3.4.0
*
* @param $root
* @param $keys
* @return bool True if value is set, false if not.
*/
final protected function multidimensional_isset( $root, $keys ) {
$result = $this->multidimensional_get( $root, $keys );
return isset( $result );
}
}
/**
* WP_Customize_Filter_Setting class.
*/
require_once( ABSPATH . WPINC . '/customize/class-wp-customize-filter-setting.php' );
/**
* WP_Customize_Header_Image_Setting class.
*/
require_once( ABSPATH . WPINC . '/customize/class-wp-customize-header-image-setting.php' );
/**
* WP_Customize_Background_Image_Setting class.
*/
require_once( ABSPATH . WPINC . '/customize/class-wp-customize-background-image-setting.php' );
/**
* WP_Customize_Nav_Menu_Item_Setting class.
*/
require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-item-setting.php' );
/**
* WP_Customize_Nav_Menu_Setting class.
*/
require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-setting.php' );
The same content is in 2 releases, WordPress 4.9.36 to 5.0.32. See them all, or every version of this file.