is_page() – Function | Developer.WordPress.org

Determines whether the query is for an existing single page.

Description

If the $page parameter is specified, this function will additionally check if the query is for one of the pages specified.

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

Parameters

$pageint|string|int[]|string[]optional: Page ID, title, slug, or array of such to check against.
Default:''

Return

bool Whether the query is for an existing single page.

More Information

Notes

Will return true if an empty value is passed
Due to certain global variables being overwritten during The Loop, is_page() will not work. In order to call it after The Loop, you must call wp_reset_query() first.

Source

function is_page( $page = '' ) {
	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_page( $page );
}

View all references View on Trac View on GitHub

Uses	Description
WP_Query::is_page()`wp-includes/class-wp-query.php`	Determines whether the query is for an existing single page.
__()`wp-includes/l10n.php`	Retrieves the translation of $text.
_doing_it_wrong()`wp-includes/functions.php`	Marks something as being incorrectly called.

Show 1 more Show less

Used by	Description
wp_title()`wp-includes/general-template.php`	Displays or retrieves page title for all areas of blog.
wp_list_pages()`wp-includes/post-template.php`	Retrieves or displays a list of pages (or hierarchical post type items) in list (li) format.
get_body_class()`wp-includes/post-template.php`	Retrieves an array of the class names for the body element.
redirect_canonical()`wp-includes/canonical.php`	Redirects incoming links to the proper URL based on the site url.
comments_template()`wp-includes/comment-template.php`	Loads the comment template specified in $file.

Changelog

Version	Description
1.5.0	Introduced.

User Contributed Notes

Codex 9 years ago

// When any single Page is being displayed.
is_page();

// When Page 42 (ID) is being displayed.
is_page( 42 );

// When the Page with a post_title of "Contact" is being displayed.
is_page( 'Contact' );

// When the Page with a post_name (slug) of "about-me" is being displayed.
is_page( 'about-me' );

/*
 * Returns true when the Pages displayed is either post ID 42,
 * or post_name "about-me", or post_title "Contact".
 * Note: the array ability was added in version 2.5.
 */
is_page( array( 42, 'about-me', 'Contact' ) );

Skip to note 10 content

Mayeenul Islam 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 18You must log in to vote on the helpfulness of this note
is_page() supports array too:
```
if ( is_page( array( 'about-us', 'contact', 'management' ) ) ) {
     // either in about us, or contact, or management page is in view
} else {
     // none of the page about us, contact or management is in view
}
```
Log in to add feedback
Skip to note 11 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note
Testing for paginated Pages

You can use this code to check whether you’re on the nth page in a Post or PAGE Page that has been divided into pages using the  QuickTag. This can be useful, for example, if you wish to display meta data only on the first page of a post divided into several pages.

Example 1
```
<?php         
$paged = $wp_query->get( 'paged' );

if ( ! $paged || $paged < 2 ) {
    // This is not a paginated page (or it's simply the first page of a paginated page/post)
} else {
   // This is a paginated page.
}
?>
```
Example 2
```
<?php
$paged = get_query_var( 'paged' ) ? get_query_var( 'paged' ) : false;
if ( $paged === false ) {
    // This is not a paginated page (or it's simply the first page of a paginated page/post)
} else {
   // This is a paginated page.
}
?>
```
Log in to add feedback

Codex 9 years ago

Testing for sub-Pages

There is no is_subpage() function yet, but you can test this with a little code:

Snippet 1

// If outside the loop.
$post = get_post();

if ( is_page() && $post->post_parent ) {
    // This is a subpage
} else {
    // This is not a subpage
}

You can create your own is_subpage() function using the code in Snippet 2. Add it to your functions.php file. It tests for a parent page in the same way as Snippet 1, but will return the ID of the page parent if there is one, or false if there isn’t.

Snippet 2

/**
 * Check whether we are on a subpage
 *
 * @return mixed ID of the parent post or false if this is not a subpage.
 */
function wpdocs_is_subpage() {
	// Load details about this page.
	$post = get_post();

	// test to see if the page has a parent
	if ( is_page() && $post->post_parent ) {
		// Return the ID of the parent post.
		return $post->post_parent;
	// There is no parent so ...
	} else {
		// ... The answer to the question is false
        	return false;
	}
}

It is advisable to use a function like that in Snippet 2, rather than using the simple test like Snippet 1, if you plan to test for sub pages frequently.

To test if the parent of a page is a specific page, for instance “About” (page id pid 2 by default), we can use the tests in Snippet 3. These tests check to see if we are looking at the page in question, as well as if we are looking at any child pages. This is useful for setting variables specific to different sections of a web site, so a different banner image, or a different heading.

Snippet 3

<?php
if ( is_page( 'about' ) || '2' == $post->post_parent ) {    
	// the page is "About", or the parent of the page is "About"
	$bannerimg = 'about.jpg';
} elseif ( is_page( 'learning' ) || '56' == $post->post_parent ) {	
	$bannerimg = 'teaching.jpg';
} elseif ( is_page( 'admissions' ) || '15' == $post->post_parent ) { 
	$bannerimg = 'admissions.jpg';
} else { 
	$bannerimg = 'home.jpg'; // just in case we are at an unclassified page, perhaps the home page
}	
?>

Snippet 4 is a function that allows you to carry out the tests above more easily. This function will return true if we are looking at the page in question (so “About”) or one of its sub pages (so a page with a parent with ID “2”).

Snippet 4

/**
 * Check whether we are on this page or a sub page
 *
 * @param int $pid Page ID to check against.
 * @return bool True if we are on this page or a sub page of this page.
 */
function wpdocs_is_tree( $pid ) {      // $pid = The ID of the page we're looking for pages underneath
	$post = get_post();               // load details about this page

	$is_tree = false;
	if ( is_page( $pid ) ) {
		$is_tree = true;            // we're at the page or at a sub page
	}

	$anc = get_post_ancestors( $post->ID );
	foreach ( $anc as $ancestor ) {
		if ( is_page() && $ancestor == $pid ) {
			$is_tree = true;
		}
	}
	return $is_tree;  // we arn't at the page, and the page is not an ancestor
}

Add Snippet 4 to your functions.php file, and call is_tree( 'id' ) to see if the current page is the page, or is a sub page of the page. In Snippet 3, is_tree( '2' ) would replace “is_page( 'about' ) || '2' == $post->post_parent” inside the first if tag.

Note that if you have more than one level of pages the parent page is the one directly above and not the one at the very top of the hierarchy.

Skip to note 13 content

Marcio Zebedeu 5 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note
is_page() can be used in the following ways:
```
is_page(198); # (int) ID
is_page('198'); # (string) ID
is_page('Some Title'); # (string) Title, case-sensitive
is_page('some-title'); # (string) Slug
is_page( array( 198, 'Some Title', 'some-title') ); # (array) => ID, Title, Slug
```
Log in to add feedback
Skip to note 14 content

marale 7 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

Use it only after ‘setup_theme’ hook i fired. Otherwise it will return false.
- It seems this may be too early these days. When testing using is_page() and giving it a slug, ‘setup_theme’ was too early. In my testing today, the earliest it worked was ‘parse_term_query’.
  
  KratosGemini 1 year ago
Log in to add feedback
Skip to note 15 content

WebbleWabble 8 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
Testing for Custom Post Type Sub-Pages
```
$page = get_post();

if ( is_singular('Custom_Post_Type_Name_Here') &amp;&amp; $page-&gt;post_parent &gt; 0 ) {
    // This is a custom post type subpage
} else {
    // This is not a custom post type subpage
}
```
Log in to add feedback
Skip to note 16 content

KratosGemini 1 year ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

Be careful about calling is_page() too early. The documentation on wp_enqueue_scripts notes:

Runs first in wp_head() where all is_home() , is_page() , etc. functions are available.

In my testing it worked as early as ‘parse_term_query’, but given the above note, it may be wiser to call in ‘wp_head’ or later to avoid issues.
- The conditional functions only work after WordPress has interpreted the request and identified the post from the main query. This is done on the parse_request action, so any time after parse_request and after priority 10, the conditional functions should work.
  
  crstauf 1 year ago
Log in to add feedback

is_page( int|string|int[]|string[] $page = ” ): bool

In this article