is_preview() │ WP 2.0.0

Is the query for a post or page preview?

For more information on this and similar theme functions, check out the Conditional Tags article in the Theme Developer Handbook.

Uses: WP_Query::is_preview()

No Hooks.

Return

true|false. Whether the query is for a post or page preview.

Usage

is_preview();

Examples

0

#1 Basic usage example: 

if ( is_preview() ){
	// some code that will be triggered only on preview pages
}

Notes

  • Global. WP_Query. $wp_query WordPress Query object.

Changelog

Since 2.0.0 Introduced.

is_preview() code WP 6.6.1

wp-includes/query.php 
function is_preview() {
	global $wp_query;

	if ( ! isset( $wp_query ) ) {
		_doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' );
		return false;
	}

	return $wp_query->is_preview();
}

Conditional tags (page type and request)

Conditional tags (all)

Queries

Main Functions