wp_get_attachment_image_srcset() – Function

Retrieves the value for an image attachment’s ‘srcset’ attribute.

Description

Parameters

$attachment_idintrequired: 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 'medium'.
Default:'medium'
$image_metaarray|nulloptional: The image meta data as returned by ‘wp_get_attachment_metadata() ‘.

Default:null

Return

string|false A 'srcset' value string or false.

Source

function wp_get_attachment_image_srcset( $attachment_id, $size = 'medium', $image_meta = null ) {
	$image = wp_get_attachment_image_src( $attachment_id, $size );

	if ( ! $image ) {
		return false;
	}

	if ( ! is_array( $image_meta ) ) {
		$image_meta = wp_get_attachment_metadata( $attachment_id );
	}

	$image_src  = $image[0];
	$size_array = array(
		absint( $image[1] ),
		absint( $image[2] ),
	);

	return wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attachment_id );
}

View all references View on Trac View on GitHub

Uses	Description
wp_calculate_image_srcset()`wp-includes/media.php`	A helper function to calculate the image sources to include in a ‘srcset’ attribute.
wp_get_attachment_image_src()`wp-includes/media.php`	Retrieves an image to represent an attachment.
wp_get_attachment_metadata()`wp-includes/post.php`	Retrieves attachment metadata for attachment ID.
absint()`wp-includes/functions.php`	Converts a value to non-negative integer.

Show 1 more Show less

Changelog

Version	Description
4.4.0	Introduced.

User Contributed Notes

Skip to note 2 content

Drew Jaynes 7 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
Using $size as an array of width and height dimensions:
```
<?php
// Specifying width of 400 (px) and height of 200 (px).
$srcset = wp_get_attachment_image_srcset( get_custom_header()->attachment_id, array( 400, 200 ) );
?>
<img src="<?php header_image(); ?>" srcset="<?php echo esc_attr( $srcset ); ?>">
```
Log in to add feedback

wp_get_attachment_image_srcset( int $attachment_id, string|int[] $size = ‘medium’, array|null $image_meta = null ): string|false

In this article

Description

See also

Parameters

Return

Source

Changelog

User Contributed Notes