get_attachment_icon_src( int $id = 0, bool $fullsize = false ): array
- Since
- 2.1.0
- Source
wp-includes/deprecated.php:1896
Compatibility
Deprecated in WordPress 2.5.0. Use wp_get_attachment_image_src()
- WordPress
- since 2.1.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
$idintoptional- Post ID.Default:
0 $fullsizebooloptional- Whether to have full image. Default false.Default:
false
Return value
array- Icon URL and full path to file, respectively.
Performance profile
How much work a call to get_attachment_icon_src() 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
- 15–61
- 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 76.
Third-party callbacks on 'icon_dir' 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 - cacheobject cache
wp_cache_get()one call below get_attachment_icon_src()
Further down the call graph this can also reach option, 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 · 8 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost get_attachment_icon_src() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 15 | _deprecated_function(), get_post() |
| always | 36–39 | _deprecated_function(), get_post(), get_attached_file(), wp_get_attachment_thumb_url(), wp_basename() |
!wp_attachment_is_image() | 38–41 | _deprecated_function(), get_post(), get_attached_file(), wp_attachment_is_image(), wp_mime_type_icon() |
wp_attachment_is_image() | 38–41 | _deprecated_function(), get_post(), get_attached_file(), wp_attachment_is_image(), wp_get_attachment_url() |
!wp_attachment_is_image() | 45–48 | _deprecated_function(), get_post(), get_attached_file(), wp_get_attachment_thumb_url(), wp_attachment_is_image(), wp_mime_type_icon() |
wp_attachment_is_image() | 45–48 | _deprecated_function(), get_post(), get_attached_file(), wp_get_attachment_thumb_url(), wp_attachment_is_image(), wp_get_attachment_url() |
!wp_attachment_is_image() | 51–54 | _deprecated_function(), get_post(), get_attached_file(), wp_attachment_is_image(), wp_mime_type_icon(), get_template_directory(), apply_filters(), wp_basename() |
!wp_attachment_is_image() | 58–61 | _deprecated_function(), get_post(), get_attached_file(), wp_get_attachment_thumb_url(), wp_attachment_is_image(), wp_mime_type_icon(), get_template_directory(), apply_filters(), wp_basename() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 76 instructions, 15–61 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 get_attachment_icon_src() runs, in this order:
Uses · 10
- _deprecated_function()Marks a function as deprecated and inform when it has been used.
- get_post()Retrieves post data given a post ID or post object.
- get_attached_file()Retrieves attached file path based on attachment ID.
- wp_get_attachment_thumb_url()Retrieves URL for an attachment thumbnail.
- wp_basename()i18n-friendly version of basename().
- wp_attachment_is_image()Determines whether an attachment is an image.
- wp_get_attachment_url()Retrieves the URL for an attachment.
- wp_mime_type_icon()Retrieves the icon for a MIME type or attachment.
- apply_filters()Calls the callback functions that have been added to a filter hook.
- get_template_directory()Retrieves template directory path for the active theme.
Used by · 1
- get_attachment_icon()Retrieve HTML content of icon attachment image element.
Source code
function get_attachment_icon_src( $id = 0, $fullsize = false ) { _deprecated_function( __FUNCTION__, '2.5.0', 'wp_get_attachment_image_src()' ); $id = (int) $id; if ( !$post = get_post($id) ) return false; $file = get_attached_file( $post->ID ); if ( !$fullsize && $src = wp_get_attachment_thumb_url( $post->ID ) ) { // We have a thumbnail desired, specified and existing. $src_file = wp_basename($src); } elseif ( wp_attachment_is_image( $post->ID ) ) { // We have an image without a thumbnail. $src = wp_get_attachment_url( $post->ID ); $src_file = & $file; } elseif ( $src = wp_mime_type_icon( $post->ID, '.svg' ) ) { // No thumb, no image. We'll look for a mime-related icon instead. /** This filter is documented in wp-includes/post.php */ $icon_dir = apply_filters( 'icon_dir', get_template_directory() . '/images' ); $src_file = $icon_dir . '/' . wp_basename($src); } if ( !isset($src) || !$src ) return false; return array($src, $src_file);}Changelog
Introduced in 2.1.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/deprecated.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.