WP_Widget::is_preview()

Determines whether the current request is inside the Customizer preview.

Description

If true — the current request is inside the Customizer preview, then the object cache gets suspended and widgets should check this to decide whether they should store anything persistently to the object cache, to transients, or anywhere else.

Return

(bool) True if within the Customizer preview, false if not.

Source

File: wp-includes/class-wp-widget.php

public function is_preview() {
		global $wp_customize;
		return ( isset( $wp_customize ) && $wp_customize->is_preview() );
	}

Used By

Used By	Description
wp-includes/class-wp-widget.php: WP_Widget::display_callback()	Generates the actual widget content (Do NOT override).
wp-includes/class-wp-widget.php: WP_Widget::update_callback()	Handles changed settings (Do NOT override).

Changelog

Version	Description
3.9.0	Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_widget/is_preview