A WordPress-centric search engine for devs and theme authors



wp_img_tag_add_srcset_and_sizes_attr ›

Since5.5.0
Deprecatedn/a
wp_img_tag_add_srcset_and_sizes_attr ( $image, $context, $attachment_id )
Parameters: (3)
  • (string) $image The HTML `img` tag where the attribute should be added.
    Required: Yes
  • (string) $context Additional context to pass to the filters.
    Required: Yes
  • (int) $attachment_id Image attachment ID.
    Required: Yes
Returns:
  • (string) Converted 'img' element with 'loading' attribute added.
Defined at:
Codex:

Adds `srcset` and `sizes` attributes to an existing `img` HTML tag.



Source

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;
}