Retrieves the value for an image attachment’s ‘srcset’ attribute.
Description
See also
Parameters
$attachment_id
intrequired- Image attachment ID.
$size
string|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_meta
array|nulloptional- The image meta data as returned by ‘wp_get_attachment_metadata() ‘.
Default:
null
Source
*
* @since 4.4.0
*
* @see wp_calculate_image_srcset()
*
* @param int $attachment_id Image attachment ID.
* @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array of
* width and height values in pixels (in that order). Default 'medium'.
* @param array|null $image_meta Optional. The image meta data as returned by 'wp_get_attachment_metadata()'.
* Default null.
* @return string|false A 'srcset' value string or false.
*/
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;
}
Changelog
Version | Description |
---|---|
4.4.0 | Introduced. |
Using
$size
as an array of width and height dimensions: