get_attachment_template(): string
- Since
- 2.0.0, 4.3.0
- Source
wp-includes/template.php:659
Description
The hierarchy for this template looks like:
- {mime_type}-{sub_type}.php
- {sub_type}.php
- {mime_type}.php
- attachment.php
An example of this is:
- image-jpeg.php
- jpeg.php
- image.php
- attachment.php
The template hierarchy and template path are filterable via the '$type_template_hierarchy' and '$type_template' dynamic hooks, where $type is 'attachment'.
Compatibility
- WordPress
- since 4.3.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.
Return value
string- Full path to attachment template file.
Performance profile
How much work a call to get_attachment_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
- 12–38
- Plugin surface
- None
- Called by
- 0
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 44.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
apply_filters()one call below get_attachment_template()
Further down the call graph this can also reach option, cache, serialize, query 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 get_attachment_template() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 12–35 | get_queried_object(), get_query_template() |
| always | 29–38 | get_queried_object(), explode(), get_query_template() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 44 | 12–38 | 3 | |
| 8.5 | 44 | 12–38 | 3 | |
| 8.4 | 44 | 12–38 | 3 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 47 | 12–41 | 3 | |
| 8.2 | 47 | 12–41 | 3 | |
| 8.1 | 47 | 12–41 | 3 | 1 fewer instruction than PHP 7.4 |
| 7.4 | 48 | 12–42 | 3 |
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
- get_queried_object()Retrieves the currently queried object.
- str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
- get_query_template()Retrieves path to a template.
Source code
function get_attachment_template() { $attachment = get_queried_object(); $templates = array(); if ( $attachment ) { if ( str_contains( $attachment->post_mime_type, '/' ) ) { list( $type, $subtype ) = explode( '/', $attachment->post_mime_type ); } else { list( $type, $subtype ) = array( $attachment->post_mime_type, '' ); } if ( ! empty( $subtype ) ) { $templates[] = "{$type}-{$subtype}.php"; $templates[] = "{$subtype}.php"; } $templates[] = "{$type}.php"; } $templates[] = 'attachment.php'; return get_query_template( 'attachment', $templates );}Changelog
Introduced in 2.0.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 6.7.7 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.