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

Description

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 be treated as an icon. Default false.Default: false

$attrstring|arrayoptional

Attributes for the image markup.Default: ''

• $srcstring

  Image attachment URL.

• $classstring

  CSS class name or space-separated list of classes. Default attachment-$size_class size-$size_class, where $size_class is the image size being requested.

• $altstring

  Image description for the alt attribute.

• $srcsetstring

  The 'srcset' attribute value.

• $sizesstring

  The 'sizes' attribute value.

• $loadingstring|falsedefault: determined by {@see wp_get_loading_optimization_attributes()}

  The 'loading' attribute value. Passing a value of false will result in the attribute being omitted for the image.

• $decodingstring

  The 'decoding' attribute value. Possible values are 'async' (default), 'sync', or 'auto'. Passing false or an empty string will result in the attribute being omitted.

• $fetchprioritystringdefault: determined by {@see wp_get_loading_optimization_attributes()}

  The 'fetchpriority' attribute value, whether high, low, or auto.

Return

string

HTML img element or empty string on failure.

Hooks fired · 4

4 hooks fire while wp_get_attachment_image() runs, in this order:

1. 1
   apply_filters( wp_get_attachment_image_context )filterline 1196 (+27 into the body)

   Filters the context in which wp_get_attachment_image() is used.

2. 2
   apply_filters( wp_img_tag_add_auto_sizes )filterline 1257 (+88 into the body)

   Filters whether auto-sizes for lazy loaded images is enabled.

3. 3
   apply_filters( wp_get_attachment_image_attributes )filterline 1282 (+113 into the body)

   Filters the list of attachment image attributes.

4. 4
   apply_filters( wp_get_attachment_image )filterline 1316 (+147 into the body)

   Filters the HTML img element representing an image attachment.

Uses · 12

• wp_get_attachment_image_src()Retrieves an image to represent an attachment.
• get_post()Retrieves post data given a post ID or post object.
• get_post_meta()Retrieves a post meta field for the given post ID.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_parse_args()Merges user defined arguments into defaults array.
• wp_get_loading_optimization_attributes()Gets loading optimization attributes.
• wp_get_attachment_metadata()Retrieves attachment metadata for attachment ID.
• absint()Converts a value to non-negative integer.
• wp_calculate_image_srcset()A helper function to calculate the image sources to include in a 'srcset' attribute.
• wp_calculate_image_sizes()Creates a 'sizes' attribute value for an image.
• wp_sizes_attribute_includes_valid_auto()Checks whether the given 'sizes' attribute includes the 'auto' keyword as the first item in the list.
• image_hwstring()Retrieves width and height attributes using given width and height values.

Used by · 13

• Twenty_Fourteen_Ephemera_Widget::widget()Outputs the HTML for this widget.
• WP_Comments_List_Table::column_response()Outputs the response column.
• WP_Media_List_Table::column_title()Handles the title column output.
• WP_Widget_Media_Image::render_media()Render the media on the frontend.
• _wp_post_thumbnail_html()Returns HTML for the post thumbnail meta box.
• block_core_gallery_render_dynamic_image()Renders a single `core/image` block for a Gallery block running in dynamic mode, applying the gallery-wide settings that affect how an image renders.
• gallery_shortcode()Builds the Gallery shortcode output.
• get_custom_logo()Returns a custom logo, linked to home unless the theme supports removing the link on the home page.
• get_the_post_thumbnail()Retrieves the post thumbnail.
• set_post_thumbnail()Sets the post thumbnail (featured image) for the given post.
• twentyfourteen_the_attached_image()Prints the attached image with a link to the next attached image.
• twentythirteen_the_attached_image()Prints the attached image with a link to the next attached image.

Source

View on Trac ↗View on GitHub ↗

1169function wp_get_attachment_image( $attachment_id, $size = 'thumbnail', $icon = false, $attr = '' ) {1170	$html  = '';1171	$image = wp_get_attachment_image_src( $attachment_id, $size, $icon );1172 1173	if ( $image ) {1174		list( $src, $width, $height ) = $image;1175 1176		$attachment = get_post( $attachment_id );1177		$size_class = $size;1178 1179		if ( is_array( $size_class ) ) {1180			$size_class = implode( 'x', $size_class );1181		}1182 1183		$default_attr = array(1184			'src'   => $src,1185			'class' => "attachment-$size_class size-$size_class",1186			'alt'   => trim( strip_tags( get_post_meta( $attachment_id, '_wp_attachment_image_alt', true ) ) ),1187		);1188 1189		/**1190		 * Filters the context in which wp_get_attachment_image() is used.1191		 *1192		 * @since 6.3.01193		 *1194		 * @param string $context The context. Default 'wp_get_attachment_image'.1195		 */1196		$context = apply_filters( 'wp_get_attachment_image_context', 'wp_get_attachment_image' );1197 1198		$attr = wp_parse_args( $attr, $default_attr );1199 1200		// Ensure that the `$width` doesn't overwrite an already valid user-provided width.1201		if ( ! isset( $attr['width'] ) || ! is_numeric( $attr['width'] ) ) {1202			$attr['width'] = $width;1203		}1204 1205		// Ensure that the `$height` doesn't overwrite an already valid user-provided height.1206		if ( ! isset( $attr['height'] ) || ! is_numeric( $attr['height'] ) ) {1207			$attr['height'] = $height;1208		}1209 1210		$loading_optimization_attr = wp_get_loading_optimization_attributes(1211			'img',1212			$attr,1213			$context1214		);1215 1216		// Add loading optimization attributes if not available.1217		$attr = array_merge( $attr, $loading_optimization_attr );1218 1219		// Omit the `decoding` attribute if the value is invalid according to the spec.1220		if ( empty( $attr['decoding'] ) || ! in_array( $attr['decoding'], array( 'async', 'sync', 'auto' ), true ) ) {1221			unset( $attr['decoding'] );1222		}1223 1224		/*1225		 * If the default value of `lazy` for the `loading` attribute is overridden1226		 * to omit the attribute for this image, ensure it is not included.1227		 */1228		if ( isset( $attr['loading'] ) && ! $attr['loading'] ) {1229			unset( $attr['loading'] );1230		}1231 1232		// If the `fetchpriority` attribute is overridden and set to false or an empty string.1233		if ( isset( $attr['fetchpriority'] ) && ! $attr['fetchpriority'] ) {1234			unset( $attr['fetchpriority'] );1235		}1236 1237		// Generate 'srcset' and 'sizes' if not already present.1238		if ( empty( $attr['srcset'] ) ) {1239			$image_meta = wp_get_attachment_metadata( $attachment_id );1240 1241			if ( is_array( $image_meta ) ) {1242				$size_array = array( absint( $width ), absint( $height ) );1243				$srcset     = wp_calculate_image_srcset( $size_array, $src, $image_meta, $attachment_id );1244				$sizes      = wp_calculate_image_sizes( $size_array, $src, $image_meta, $attachment_id );1245 1246				if ( $srcset && ( $sizes || ! empty( $attr['sizes'] ) ) ) {1247					$attr['srcset'] = $srcset;1248

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.