get_query_template( string $type, string[] $templates = array() ): string
- Since
- 1.5.0
- Source
wp-includes/template.php:23
Description
Used to quickly retrieve the path of a template without including the file extension. It will also check the parent theme, if the file exists, with the use of locatetemplate(). Allows for more generic template location without the use of the other get*_template() functions.
Compatibility
- WordPress
- since 1.5.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
$typestring- Filename without extension.
$templatesstring[]optional- An optional list of template candidates.Default:
array()
Return value
string- Full path to template file.
Performance profile
How much work a call to get_query_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
- Trivial
- Scaling
- Constant
- Instructions
- 31–34
- Plugin surface
- 2 hooks
- Called by
- 18
Touches nothing outside its own arguments.
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 34.
Third-party callbacks on '{$type}_template_hierarchy', '{$type}_template' run inside this call, and their cost is not bounded by anything here.
18 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly
Further down the call graph this can also reach option, query, 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 · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost get_query_template() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 31–34 | apply_filters(), locate_template(), locate_block_template(), apply_filters() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 34 | 31–34 | 1 | |
| 8.5 | 34 | 31–34 | 1 | |
| 8.4 | 34 | 31–34 | 1 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 37 | 34–37 | 1 | |
| 8.2 | 37 | 34–37 | 1 | |
| 8.1 | 37 | 34–37 | 1 | |
| 7.4 | 37 | 34–37 | 1 |
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 get_query_template() runs, in this order:
- apply_filters( {$type}_template_hierarchy )filterline 62 (+39 into the body)
Filters the list of template filenames that are searched for when retrieving a template to use.
- apply_filters( {$type}_template )filterline 103 (+80 into the body)
Filters the path of the queried template by type.
Uses · 3
- apply_filters()Calls the callback functions that have been added to a filter hook.
- locate_template()Retrieves the name of the highest priority template file that exists.
- locate_block_template()Finds a block template with equal or higher specificity than a given PHP template file.
Used by · 18
- get_404_template()Retrieves path of 404 template in current or parent template.
- get_archive_template()Retrieves path of archive template in current or parent template.
- get_attachment_template()Retrieves path of attachment template in current or parent template.
- get_author_template()Retrieves path of author template in current or parent template.
- get_category_template()Retrieves path of category template in current or parent template.
- get_date_template()Retrieves path of date template in current or parent template.
- get_embed_template()Retrieves an embed template path in the current or parent template.
- get_front_page_template()Retrieves path of front page template in current or parent template.
- get_home_template()Retrieves path of home template in current or parent template.
- get_index_template()Retrieves path of index template in current or parent template.
- get_page_template()Retrieves path of page template in current or parent template.
- get_paged_template()Retrieve path of paged template in current or parent template.
Show all 18
- get_privacy_policy_template()Retrieves path of Privacy Policy page template in current or parent template.
- get_search_template()Retrieves path of search template in current or parent template.
- get_single_template()Retrieves path of single template in current or parent template. Applies to single Posts, single Attachments, and single custom post types.
- get_singular_template()Retrieves the path of the singular template in current or parent template.
- get_tag_template()Retrieves path of tag template in current or parent template.
- get_taxonomy_template()Retrieves path of custom taxonomy term template in current or parent template.
Changelog
Introduced in 1.5.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/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.