wp_calculate_image_srcset filter-hook . WP 4.4.0

Filters an image's 'srcset' sources.

Usage

add_filter( 'wp_calculate_image_srcset', 'filter_function_name_3981', 10, 5 );
function filter_function_name_3981( $sources, $size_array, $image_src, $image_meta, $attachment_id ){
	// filter...

	return $sources;
}

$sources(array)

One or more arrays of source data to include in the 'srcset'.

• $width (array)

  • $url (string)
    The URL of an image source.

  • $descriptor (string)
    The descriptor type used in the image candidate string, either 'w' or 'x'.

  • $value (int)
    The source width if paired with a 'w' descriptor, or a pixel density value if paired with an 'x' descriptor.

$size_array(array)

An array of requested width and height values.

• $0 (int)
  The width in pixels.

• $1 (int)
  The height in pixels.

$image_src(string)

The 'src' of the image.

$image_meta(array)

The image meta data as returned by 'wp_get_attachment_metadata()'.

$attachment_id(int)

Image attachment ID or 0.

Changelog

Where the hook is called

$sources = apply_filters( 'wp_calculate_image_srcset', $sources, $size_array, $image_src, $image_meta, $attachment_id );

Where in WP core the hook is used