How to use intermediate_image_sizes filter in WordPress

intermediate_image_sizes filter

Filters the list of intermediate image sizes.

To use intermediate_image_sizes 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 weplugins_modify_intermediate_image_sizes_defaults which takes 1 parameter and we registered using add_filter. The first parameter intermediate_image_sizes is the name of the hook, the second parameter weplugins_modify_intermediate_image_sizes_defaults is the name of the function which needs to be called, the third parameter is the priority of calling the hook if the same hook is used multiple times, and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometimes, you have to remove a registered hook so you can use remove_filter to remove intermediate_image_sizes filter.

Parameters

Below the 1 parameter is required to use this hook.

• $default_sizes : (string[]) An array of intermediate image size names. Defaults are ‘thumbnail’, ‘medium’, ‘medium_large’, ‘large’.

Live Example 1: Modifying Default Image Sizes

Below is an example of how you can use this hook to modify the default image sizes.

function weplugins_modify_intermediate_image_sizes_defaults($default_sizes) {
    // Update the $default_sizes variable according to your website requirements and return this variable. 
    // You can modify the $default_sizes variable conditionally too if you want.
    return $default_sizes;
}
// add the filter
add_filter("intermediate_image_sizes", "weplugins_modify_intermediate_image_sizes_defaults", 10, 1);

Live Example 2: Removing the Hook Callback

To remove a hook callback, use the example below.

remove_filter("intermediate_image_sizes", "weplugins_modify_intermediate_image_sizes_defaults", 10, 1);

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

Live Example 3: Custom Image Sizes

Here’s an example of how to add custom image sizes to the default list.

function weplugins_add_custom_image_sizes($default_sizes) {
    // Adding custom image sizes
    $default_sizes[] = 'custom_size';
    return $default_sizes;
}
// add the filter
add_filter("intermediate_image_sizes", "weplugins_add_custom_image_sizes", 10, 1);

Contact Us

If you’re having any trouble using this hook or need customization, please contact us and we’d be happy to assist you.