wp_img_tag_add_srcset_and_sizes_attr( string $image, string $context, int $attachment_id )
Adds srcset
and sizes
attributes to an existing img
HTML tag.
Parameters
- $image
-
(string) (Required) The HTML
img
tag where the attribute should be added. - $context
-
(string) (Required) Additional context to pass to the filters.
- $attachment_id
-
(int) (Required) Image attachment ID.
Return
(string) Converted 'img' element with 'loading' attribute added.
Source
File: wp-includes/media.php
function wp_img_tag_add_srcset_and_sizes_attr( $image, $context, $attachment_id ) { /** * Filters whether to add the `srcset` and `sizes` HTML attributes to the img tag. Default `true`. * * Returning anything else than `true` will not add the attributes. * * @since 5.5.0 * * @param bool $value The filtered value, defaults to `true`. * @param string $image The HTML `img` tag where the attribute should be added. * @param string $context Additional context about how the function was called or where the img tag is. * @param int $attachment_id The image attachment ID. */ $add = apply_filters( 'wp_img_tag_add_srcset_and_sizes_attr', true, $image, $context, $attachment_id ); if ( true === $add ) { $image_meta = wp_get_attachment_metadata( $attachment_id ); return wp_image_add_srcset_and_sizes( $image, $image_meta, $attachment_id ); } return $image; }
Changelog
Version | Description |
---|---|
5.5.0 | Introduced. |
© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_img_tag_add_srcset_and_sizes_attr