How to use max_srcset_image_width filter in WordPress

max_srcset_image_width filter

Filters the maximum image width to be included in a ‘srcset’ attribute.

To use max_srcset_image_width filter, first you have to register it using add_filter. You can write this code into functions.php of your activated theme or in a custom WordPress Plugin.

We at WePlugins, always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.

In the below live example, we have defined a function modify_max_srcset_image_width_defaults which takes 2 parameters and we registered using add_filter. The first parameter max_srcset_image_width is name of the hook, The second parameter modify_max_srcset_image_width_defaults is name of the function which need to be called, third parameter is the priority of calling the hook if same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometime, you have to remove a registered hook so you can use remove_filter to remove max_srcset_image_width filter.

Parameters

Below are the 2 parameters are required to use this hook.

• $max_width : (int) The maximum image width to be included in the ‘srcset’. Default ‘2048’.
• $size_array : (int[]) An array of requested width and height values.
  • (int) The width in pixels.
  • (int) The height in pixels.

Live Example 1: Removing max_srcset_image_width

This example demonstrates how you can remove the max_srcset_image_width filter.

    function weplugins_remove_max_srcset_image_width( $max_width ) {
        return false;
    }
    add_filter( 'max_srcset_image_width', 'weplugins_remove_max_srcset_image_width' );
    

Live Example 2: Modifying max_srcset_image_width

Below is an example of how you can modify the max_srcset_image_width value.

    function weplugins_modify_max_srcset_image_width_defaults( $max_width, $size_array ) {
        // Update the $max_width variable according to your website requirements and return this variable.
        // You can modify the $max_width variable conditionally too if you want.
        return $max_width;
    }
    // add the filter
    add_filter( "max_srcset_image_width", "weplugins_modify_max_srcset_image_width_defaults", 10, 2 );
    

Live Example 3: Removing a Hook Callback

To remove a hook callback, use the example below.

    remove_filter( "max_srcset_image_width", "weplugins_modify_max_srcset_image_width_defaults", 10, 2 );
    

Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.

Contact Us

If you need customization or are having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.