WP_Theme::get_page_templates( WP_Post|null $post = null, string $post_type = 'page' ): string[]
- Since
- 3.4.0, 4.7.0
- Source
wp-includes/class-wp-theme.php:1394
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
$postWP_Post|nulloptional- The post being edited, provided for context.Default:
null $post_typestringoptional- Post type to get the templates for. Default 'page'.
If a post is provided, its post type is used.Default:'page'
Return value
string[]- Array of template header names keyed by the template file name.
Performance profile
How much work a call to WP_Theme::get_page_templates() 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
- 34–39
- Plugin surface
- 2 hooks
- Called by
- 0
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 40.
Third-party callbacks on 'theme_templates', 'theme_{$post_type}_templates' run inside this call, and their cost is not bounded by anything here.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
apply_filters()called directly - querycontent query
get_post()one call below WP_Theme::get_page_templates()
Further down the call graph this can also reach option, cache, serialize 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 WP_Theme::get_page_templates() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 34–35 | ->get_post_templates(), apply_filters(), apply_filters() |
| always | 38–39 | get_post_type(), ->get_post_templates(), apply_filters(), apply_filters() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 40 | 34–39 | 2 | |
| 8.5 | 40 | 34–39 | 2 | |
| 8.4 | 40 | 34–39 | 2 | |
| 8.3 | 40 | 34–39 | 2 | |
| 8.2 | 40 | 34–39 | 2 | |
| 8.1 | 40 | 34–39 | 2 | 1 fewer instruction than PHP 7.4 |
| 7.4 | 41 | 34–40 | 2 |
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.
Hooks and filters fired · 2
2 hooks fire while WP_Theme::get_page_templates() runs, in this order:
- apply_filters( theme_templates )filterline 1412 (+18 into the body)
Filters list of page templates for a theme.
- apply_filters( theme_{$post_type}_templates )filterline 1434 (+40 into the body)
Filters list of page templates for a theme.
Uses · 3
- get_post_type()Retrieves the post type of the current post or of a given post.
- apply_filters()Calls the callback functions that have been added to a filter hook.
- WP_Theme::get_post_templates()Returns the theme's post templates.
Source code
public function get_page_templates( $post = null, $post_type = 'page' ) { if ( $post ) { $post_type = get_post_type( $post ); } $post_templates = $this->get_post_templates(); $post_templates = isset( $post_templates[ $post_type ] ) ? $post_templates[ $post_type ] : array(); /** * Filters list of page templates for a theme. * * @since 4.9.6 * * @param string[] $post_templates Array of template header names keyed by the template file name. * @param WP_Theme $theme The theme object. * @param WP_Post|null $post The post being edited, provided for context, or null. * @param string $post_type Post type to get the templates for. */ $post_templates = (array) apply_filters( 'theme_templates', $post_templates, $this, $post, $post_type ); /** * Filters list of page templates for a theme. * * The dynamic portion of the hook name, `$post_type`, refers to the post type. * * Possible hook names include: * * - `theme_post_templates` * - `theme_page_templates` * - `theme_attachment_templates` * * @since 3.9.0 * @since 4.4.0 Converted to allow complete control over the `$page_templates` array. * @since 4.7.0 Added the `$post_type` parameter. * * @param string[] $post_templates Array of template header names keyed by the template file name. * @param WP_Theme $theme The theme object. * @param WP_Post|null $post The post being edited, provided for context, or null. * @param string $post_type Post type to get the templates for. */ $post_templates = (array) apply_filters( "theme_{$post_type}_templates", $post_templates, $this, $post, $post_type ); return $post_templates; }Changelog
Introduced in 3.4.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
$post_type parameter.from the docblockAbout this page
- Parsed data
- Generated from the wordpress-develop 6.9.7 tag, from
src/wp-includes/class-wp-theme.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.