wp_get_attachment_image_src( int $attachment_id, string|int[] $size = 'thumbnail', bool $icon = false ): array|false

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$attachment_idint

Image attachment ID.

$sizestring|int[]optional

Image size. Accepts any registered image size name, or an array of width and height values in pixels (in that order). Default 'thumbnail'.Default: 'thumbnail'

$iconbooloptional

Whether the image should fall back to a mime type icon. Default false.Default: false

Return value

array|false

Array of image data, or boolean false if no image is available.

• $0string

  Image source URL.

• $1int

  Image width in pixels.

• $2int

  Image height in pixels.

• $3bool

  Whether the image is a resized image.

Performance profile

How much work a call to wp_get_attachment_image_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

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

17–68

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 71.

Plugin surface

2 hooks

Third-party callbacks on 'icon_dir', 'wp_get_attachment_image_src' run inside this call, and their cost is not bounded by anything here.

Called by

16

16 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• cacheobject cachewp_cache_get()one call below wp_get_attachment_image_src()
• querycontent queryget_post()one call below wp_get_attachment_image_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 · 4 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_get_attachment_image_src() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while wp_get_attachment_image_src() runs, in this order:

1. 1
   apply_filters( icon_dir )filterline 979 (+11 into the body)

   Filters the icon directory path.

2. 2
   apply_filters( wp_get_attachment_image_src )filterline 1019 (+51 into the body)

   Filters the attachment image source result.

Uses · 5

• image_downsize()Scales an image to fit a particular size (such as 'thumb' or 'medium').
• 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.
• wp_basename()i18n-friendly version of basename().
• wp_getimagesize()Allows PHP's getimagesize() to be debuggable when necessary.

Used by · 16

• Custom_Background::handle_upload()Handles an Image upload for the background image.
• Custom_Background::wp_set_background_image()
• Custom_Image_Header::step_2()Displays second step of custom header image page.
• WP_REST_Attachments_Controller::prepare_item_for_response()Prepares a single attachment output for response.
• edit_form_image_editor()Displays the image and editor in the post editor
• get_media_item()Retrieves HTML form for modifying the image attachment.
• get_oembed_response_data_rich()Filters the oEmbed response data to return an iframe embed code.
• twentyfifteen_post_nav_background()Add featured image as background image to post navigation elements.
• twentytwenty_get_custom_logo()Get the information about the logo.
• wp_get_attachment_image()Gets an HTML img element representing an image attachment.
• wp_get_attachment_image_sizes()Retrieves the value for an image attachment's 'sizes' attribute.
• wp_get_attachment_image_srcset()Retrieves the value for an image attachment's 'srcset' attribute.

Source code

View on Trac ↗View on GitHub ↗

968function wp_get_attachment_image_src( $attachment_id, $size = 'thumbnail', $icon = false ) {969	// Get a thumbnail or intermediate image if there is one.970	$image = image_downsize( $attachment_id, $size );971	if ( ! $image ) {972		$src = false;973 974		if ( $icon ) {975			$src = wp_mime_type_icon( $attachment_id, '.svg' );976 977			if ( $src ) {978				/** This filter is documented in wp-includes/post.php */979				$icon_dir = apply_filters( 'icon_dir', ABSPATH . WPINC . '/images/media' );980 981				$src_file = $icon_dir . '/' . wp_basename( $src );982 983				list( $width, $height ) = wp_getimagesize( $src_file );984 985				$ext = strtolower( substr( $src_file, -4 ) );986 987				if ( '.svg' === $ext ) {988					// SVG does not have true dimensions, so this assigns width and height directly.989					$width  = 48;990					$height = 64;991				} else {992					list( $width, $height ) = wp_getimagesize( $src_file );993				}994			}995		}996 997		if ( $src && $width && $height ) {998			$image = array( $src, $width, $height, false );999		}1000	}1001	/**1002	 * Filters the attachment image source result.1003	 *1004	 * @since 4.3.01005	 *1006	 * @param array|false  $image         {1007	 *     Array of image data, or boolean false if no image is available.1008	 *1009	 *     @type string $0 Image source URL.1010	 *     @type int    $1 Image width in pixels.1011	 *     @type int    $2 Image height in pixels.1012	 *     @type bool   $3 Whether the image is a resized image.1013	 * }1014	 * @param int          $attachment_id Image attachment ID.1015	 * @param string|int[] $size          Requested image size. Can be any registered image size name, or1016	 *                                    an array of width and height values in pixels (in that order).1017	 * @param bool         $icon          Whether the image should be treated as an icon.1018	 */1019	return apply_filters( 'wp_get_attachment_image_src', $image, $attachment_id, $size, $icon );1020}

Changelog

Introduced in 2.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 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/media.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.