wp_get_attachment_image_srcset( int $attachment_id, string|int[] $size = 'medium', array $image_meta = null )
Retrieves the value for an image attachment’s ‘srcset’ attribute.
Description
See also
Parameters
- $attachment_id
-
(int) (Required) 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 value: 'medium'
- $image_meta
-
(array) (Optional) The image meta data as returned by 'wp_get_attachment_metadata()'.
Default value: null
Return
(string|false) A 'srcset' value string or false.
Source
File: wp-includes/media.php
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 );
} Changelog
| Version | Description |
|---|---|
| 4.4.0 | Introduced. |
© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_get_attachment_image_srcset