is_page_template( string|string[] $template = '' ): bool

Description

Parameters

$templatestring|string[]optional

The specific template filename or array of templates to match.Default: ''

Return

bool

True on success, false on failure.

Uses · 3

• is_singular()Determines whether the query is for an existing single post of any post type (post, attachment, page, custom post types).
• get_page_template_slug()Gets the specific template filename for a given post.
• get_queried_object_id()Retrieves the ID of the currently queried object.

Used by · 7

• get_body_class()Retrieves an array of the class names for the body element.
• twentyeleven_body_classes()Add two classes to the array of body classes.
• twentyfourteen_body_classes()Extend the default WordPress body classes.
• twentyfourteen_post_thumbnail()Display an optional post thumbnail.
• twentytwelve_body_class()Extend the default WordPress body classes.
• twentytwelve_content_width()Adjust content width in certain contexts.
• twentytwenty_body_classes()Adds conditional body classes.

Source

View on Trac ↗View on GitHub ↗

1851function is_page_template( $template = '' ) {1852	if ( ! is_singular() ) {1853		return false;1854	}1855 1856	$page_template = get_page_template_slug( get_queried_object_id() );1857 1858	if ( empty( $template ) ) {1859		return (bool) $page_template;1860	}1861 1862	if ( $template === $page_template ) {1863		return true;1864	}1865 1866	if ( is_array( $template ) ) {1867		if ( ( in_array( 'default', $template, true ) && ! $page_template )1868			|| in_array( $page_template, $template, true )1869		) {1870			return true;1871		}1872	}1873 1874	return ( 'default' === $template && ! $page_template );1875}

History

Introduced in 2.5.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/post-template.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.