wp_calculate_image_srcset filter-hookWP 4.4.0

Filters an image's 'srcset' sources.

Usage

add_filter( 'wp_calculate_image_srcset', 'wp_kama_calculate_image_srcset_filter', 10, 5 );

/**
 * Function for `wp_calculate_image_srcset` filter-hook.
 * 
 * @param array  $sources       One or more arrays of source data to include in the 'srcset'.
 * @param array  $size_array    An array of requested width and height values.
 * @param string $image_src     The 'src' of the image.
 * @param array  $image_meta    The image meta data as returned by 'wp_get_attachment_metadata()'.
 * @param int    $attachment_id Image attachment ID or 0.
 *
 * @return array
 */
function wp_kama_calculate_image_srcset_filter( $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

Since 4.4.0 Introduced.

Where the hook is called

wp_calculate_image_srcset()
wp_calculate_image_srcset
wp-includes/media.php 1419
$sources = apply_filters( 'wp_calculate_image_srcset', $sources, $size_array, $image_src, $image_meta, $attachment_id );

Where the hook is used in WordPress

Usage not found.