W3cubDocs

WP_Customize_Setting::_preview_filter( mixed $original )

Callback function to filter non-multidimensional theme mods and options.

Description

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.

Parameters

$original: (mixed) (Required) Old value.

Return

(mixed) New or old value.

Source

File: wp-includes/class-wp-customize-setting.php

public function _preview_filter( $original ) {
		if ( ! $this->is_current_blog_previewed() ) {
			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;
	}

Uses

Uses	Description
wp-includes/class-wp-customize-setting.php: WP_Customize_Setting::is_current_blog_previewed()	Return true if the current site is not the same as the previewed site.
wp-includes/class-wp-customize-setting.php: WP_Customize_Setting::post_value()	Fetch and sanitize the $_POST value for the setting.

Changelog

Version	Description
3.4.0	Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_customize_setting/_preview_filter