prepend_attachment( string $content ): string
- Since
- 2.0.0
- Source
wp-includes/post-template.php:1723
Compatibility
- WordPress
- since 2.0.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
$contentstring
Return value
string
Performance profile
How much work a call to prepend_attachment() 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
- 7–59
- Plugin surface
- 1 hook
- Called by
- 1
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 81.
Third-party callbacks on 'prepend_attachment' run inside this call, and their cost is not bounded by anything here.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- querycontent query
get_post()called directly - hookthird-party callbacks
apply_filters()called directly
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 · 5 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost prepend_attachment() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 7–10 | get_post() |
!empty($post) && !wp_attachment_is() | 36 | get_post(), wp_attachment_is(), wp_attachment_is(), wp_get_attachment_link(), apply_filters() |
!empty($post) | 36 | get_post(), wp_attachment_is(), wp_attachment_is(), wp_get_attachment_url(), src(), apply_filters() |
!empty($post) && wp_attachment_is() && !has_post_thumbnail() | 42–52 | get_post(), wp_attachment_is(), get_the_ID(), wp_get_attachment_metadata(), wp_get_attachment_url(), has_post_thumbnail(), wp_video_shortcode(), apply_filters() |
!empty($post) && wp_attachment_is() && has_post_thumbnail() | 49–59 | get_post(), wp_attachment_is(), get_the_ID(), wp_get_attachment_metadata(), wp_get_attachment_url(), has_post_thumbnail(), get_post_thumbnail_id(), wp_get_attachment_url(), wp_video_shortcode(), apply_filters() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 81 instructions, 7–59 executed per call, 7 branches. The work does not change between versions.
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 · 1
One hook fires while prepend_attachment() runs, in this order:
- apply_filters( prepend_attachment )filterline 1759 (+36 into the body)
Filters the attachment markup to be prepended to the post content.
Uses · 11
- get_post()Retrieves post data given a post ID or post object.
- wp_attachment_is()Verifies an attachment is of a given type.
- wp_get_attachment_metadata()Retrieves attachment metadata for attachment ID.
- get_the_ID()Retrieves the ID of the current item in the WordPress Loop.
- wp_get_attachment_url()Retrieves the URL for an attachment.
- has_post_thumbnail()Determines whether a post has an image attached.
- get_post_thumbnail_id()Retrieves the post thumbnail ID.
- wp_video_shortcode()Builds the Video shortcode output.
- wp_audio_shortcode()Builds the Audio shortcode output.
- wp_get_attachment_link()Retrieves an attachment page link using an image or icon, if possible.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 1
- wp_embed_excerpt_attachment()Filters the post excerpt for the embed template.
Source code
function prepend_attachment( $content ) { $post = get_post(); if ( empty( $post->post_type ) || 'attachment' !== $post->post_type ) { return $content; } if ( wp_attachment_is( 'video', $post ) ) { $meta = wp_get_attachment_metadata( get_the_ID() ); $atts = array( 'src' => wp_get_attachment_url() ); if ( ! empty( $meta['width'] ) && ! empty( $meta['height'] ) ) { $atts['width'] = (int) $meta['width']; $atts['height'] = (int) $meta['height']; } if ( has_post_thumbnail() ) { $atts['poster'] = wp_get_attachment_url( get_post_thumbnail_id() ); } $p = wp_video_shortcode( $atts ); } elseif ( wp_attachment_is( 'audio', $post ) ) { $p = wp_audio_shortcode( array( 'src' => wp_get_attachment_url() ) ); } else { $p = '<p class="attachment">'; // Show the medium sized image representation of the attachment if available, and link to the raw file. $p .= wp_get_attachment_link( 0, 'medium', false ); $p .= '</p>'; } /** * Filters the attachment markup to be prepended to the post content. * * @since 2.0.0 * * @see prepend_attachment() * * @param string $p The attachment HTML output. */ $p = apply_filters( 'prepend_attachment', $p ); return "$p\n$content";}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.9.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.