is_preview(): bool

Description

Return

bool

Whether the query is for a post or page preview.

Uses · 2

• _doing_it_wrong()Marks something as being incorrectly called.
• __()Retrieves the translation of $text.

Used by · 7

• _wp_link_page()Helper function for wp_link_pages().
• redirect_canonical()Redirects incoming links to the proper URL based on the site url.
• twentyfifteen_categorized_blog()Determine whether blog/site has more than one category.
• twentyfourteen_categorized_blog()Find out if blog has more than one category.
• twentyseventeen_categorized_blog()Returns true if a blog has more than 1 category.
• twentysixteen_categorized_blog()Determines whether blog/site has more than one category.
• wp_post_preview_js()Outputs a small JS snippet on preview tabs/windows to remove `window.name` when a user is navigating to another page.

Source

View on Trac ↗View on GitHub ↗

632function is_preview() {633	global $wp_query;634 635	if ( ! isset( $wp_query ) ) {636		_doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' );637		return false;638	}639 640	return $wp_query->is_preview();641}

History

Introduced in 2.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/query.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.