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

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

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.

Hooks fired · 2

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

1. 1
   apply_filters( icon_dir )filterline 1071 (+13 into the body)

   Filters the icon directory path.

2. 2
   apply_filters( wp_get_attachment_image_src )filterline 1119 (+61 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()Adds featured image as background image to post navigation elements.
• twentytwenty_get_custom_logo()Gets 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

View on Trac ↗View on GitHub ↗

1058function wp_get_attachment_image_src( $attachment_id, $size = 'thumbnail', $icon = false ) {1059	// Get a thumbnail or intermediate image if there is one.1060	$image = image_downsize( $attachment_id, $size );1061	if ( ! $image ) {1062		$src    = false;1063		$width  = 0;1064		$height = 0;1065 1066		if ( $icon ) {1067			$src = wp_mime_type_icon( $attachment_id, '.svg' );1068 1069			if ( $src ) {1070				/** This filter is documented in wp-includes/post.php */1071				$icon_dir = apply_filters( 'icon_dir', ABSPATH . WPINC . '/images/media' );1072 1073				$src_file = $icon_dir . '/' . wp_basename( $src );1074 1075				$image_size = wp_getimagesize( $src_file );1076				if ( is_array( $image_size ) ) {1077					$width  = $image_size[0];1078					$height = $image_size[1];1079				}1080 1081				$ext = strtolower( substr( $src_file, -4 ) );1082 1083				if ( '.svg' === $ext ) {1084					// SVG does not have true dimensions, so this assigns width and height directly.1085					$width  = 48;1086					$height = 64;1087				} else {1088					$image_size = wp_getimagesize( $src_file );1089					if ( is_array( $image_size ) ) {1090						$width  = $image_size[0];1091						$height = $image_size[1];1092					}1093				}1094			}1095		}1096 1097		if ( $src && $width && $height ) {1098			$image = array( $src, $width, $height, false );1099		}1100	}1101	/**1102	 * Filters the attachment image source result.1103	 *1104	 * @since 4.3.01105	 *1106	 * @param array|false  $image         {1107	 *     Array of image data, or boolean false if no image is available.1108	 *1109	 *     @type string $0 Image source URL.1110	 *     @type int    $1 Image width in pixels.1111	 *     @type int    $2 Image height in pixels.1112	 *     @type bool   $3 Whether the image is a resized image.1113	 * }1114	 * @param int          $attachment_id Image attachment ID.1115	 * @param string|int[] $size          Requested image size. Can be any registered image size name, or1116	 *                                    an array of width and height values in pixels (in that order).1117	 * @param bool         $icon          Whether the image should be treated as an icon.1118	 */1119	$source = apply_filters( 'wp_get_attachment_image_src', $image, $attachment_id, $size, $icon );1120	if ( is_array( $source ) && isset( $source[0] ) && is_string( $source[0] ) ) {1121		return array(1122			$source[0],1123			(int) ( $source[1] ?? 0 ),1124			(int) ( $source[2] ?? 0 ),1125			(bool) ( $source[3] ?? false ),1126		);1127	}1128	return false;1129}

History

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 7.1.0 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.