How to use image_get_intermediate_size filter in WordPress

image_get_intermediate_size filter

To use the image_get_intermediate_size 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_image_get_intermediate_size_defaults which takes 3 parameters and we registered it using add_filter. The first parameter image_get_intermediate_size is the name of the hook, the second parameter weplugins_modify_image_get_intermediate_size_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 the image_get_intermediate_size filter.

Parameters

Below are the 3 parameters required to use this hook.

• $data: (array) Array of file relative path, width, and height on success. May also include file absolute path and URL.
• $post_id: (int) The ID of the image attachment.
• $size: (string|int[]) Requested image size. Can be any registered image size name, or an array of width and height values in pixels (in that order).

Live Example

Below is an example of how you can use this hook.

    function weplugins_modify_image_get_intermediate_size_defaults($data, $post_id, $size) { 
        // Update the $data variable according to your website requirements and return this variable. You can modify the $data variable conditionally too if you want.
        return $data; 
    }
    // add the filter
    add_filter("image_get_intermediate_size", "weplugins_modify_image_get_intermediate_size_defaults", 10, 3);
    

Example 1: Custom Image Size Adjustment

This example demonstrates how to customize the image size for specific use cases.

    function weplugins_custom_image_size_adjustment($data, $post_id, $size) { 
        // Adjust the $data based on custom requirements.
        if ($size === 'custom-size') {
            $data['width'] = 300;
            $data['height'] = 200;
        }
        return $data; 
    }
    add_filter("image_get_intermediate_size", "weplugins_custom_image_size_adjustment", 10, 3);
    

Example 2: Conditional Image Path Modification

In this example, we modify the file path of the image conditionally based on the post ID.

    function weplugins_conditional_image_path_modification($data, $post_id, $size) { 
        if ($post_id === 123) {
            $data['file'] = 'path/to/custom/image.jpg';
        }
        return $data; 
    }
    add_filter("image_get_intermediate_size", "weplugins_conditional_image_path_modification", 10, 3);
    

Example 3: Removing a Hook Callback

To remove a hook callback, use the example below.

    remove_filter("image_get_intermediate_size", "weplugins_modify_image_get_intermediate_size_defaults", 10, 3);
    

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 trouble using this hook, please contact us and we’d be happy to assist you.