is_page_template( string|string[] $template = '' ): bool
- Since
- 2.5.0, 4.2.0, 4.7.0
- Source
wp-includes/post-template.php:1812
Description
This template tag allows you to determine if you are in a page template.
You can optionally provide a template filename or array of template filenames and then the check will be specific to that template.
For more information on this and similar theme functions, check out the https://developer.wordpress.org/themes/basics/conditional-tags/ Conditional Tags article in the Theme Developer Handbook.
Compatibility
- WordPress
- since 4.7.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$templatestring|string[]optional- The specific template filename or array of templates to match.Default:
''
Return value
bool- True on success, false on failure.
Performance profile
How much work a call to is_page_template() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Heavy
- Scaling
- Constant
- Instructions
- 5–27
- Plugin surface
- None
- Called by
- 7
Reaches the database via get_post().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 32.
Nothing here hands control to plugin code.
7 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- querycontent query
get_post()one call below is_page_template()
Further down the call graph this can also reach hook, cache, serialize, option and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost is_page_template() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!is_singular() | 5 | is_singular() |
is_singular() | 14–27 | is_singular(), get_queried_object_id(), get_page_template_slug() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 32 | 5–27 | 8 | |
| 8.5 | 32 | 5–27 | 8 | |
| 8.4 | 32 | 5–27 | 8 | 6 fewer instructions than PHP 8.3 |
| 8.3 | 38 | 5–33 | 8 | |
| 8.2 | 38 | 5–33 | 8 | |
| 8.1 | 38 | 5–33 | 8 | |
| 7.4 | 38 | 5–33 | 8 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
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 code
function is_page_template( $template = '' ) { if ( ! is_singular() ) { return false; } $page_template = get_page_template_slug( get_queried_object_id() ); if ( empty( $template ) ) { return (bool) $page_template; } if ( $template === $page_template ) { return true; } if ( is_array( $template ) ) { if ( ( in_array( 'default', $template, true ) && ! $page_template ) || in_array( $page_template, $template, true ) ) { return true; } } return ( 'default' === $template && ! $page_template );}Changelog
Introduced in 2.5.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
$template parameter was changed to also accept an array of page templates.from the docblockAbout this page
- Parsed data
- Generated from the wordpress-develop 6.7.7 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.