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.


Top ↑

Return

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


Top ↑

Source

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

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


Top ↑

Changelog

Changelog
Version Description
3.9.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.