WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_calculate_image_srcset

apply_filters( ‘wp_calculate_image_srcset’, array $sources, array $size_array, string $image_src, array $image_meta, int $attachment_id )

In this article

Back to top

Filters an image’s ‘srcset’ sources.

Parameters

$sourcesarray
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_arrayarray
An array of requested width and height values.
  • 0 int
    The width in pixels.
  • 1 int
    The height in pixels.
$image_srcstring
The 'src' of the image.
$image_metaarray
The image meta data as returned by ‘wp_get_attachment_metadata() ‘.
$attachment_idint
Image attachment ID or 0.

Source

*                                  either 'w' or 'x'.

View all references View on Trac View on GitHub

Changelog

VersionDescription
4.4.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    axew3
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    function abc_custom_image_srcset( $sources, $size_array, $image_src, $image_meta, $attachment_id ){

   $w = get_custom_header()->width;

// srcset val
      $sources[$w] = array(
             'url'        => 'myfolder/myimage.jpg',
             'descriptor' => 'w',
             'value'      => $w,
      );
         return $sources;
      
   }
   add_filter( 'wp_calculate_image_srcset', 'abc_custom_image_srcset', 10, 5 );

You must log in before being able to contribute a note or feedback.