How to use image_resize_dimensions filter in WordPress

image_resize_dimensions filter

Returning a non-null value from the filter will effectively short-circuit image_resize_dimensions(), returning that value instead.

To use image_resize_dimensions 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_image_resize_dimensions_defaults which takes 6 parameters and we registered using add_filter. The first parameter image_resize_dimensions is the name of the hook, the second parameter modify_image_resize_dimensions_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 image_resize_dimensions filter.

Example 1: Adding a Custom Image Resize Dimension

Below is an example of how you can use this hook to modify image dimensions.

    function weplugins_modify_image_resize_dimensions_defaults($null, $orig_w, $orig_h, $dest_w, $dest_h, $crop) {
        // Update the $null variable according to your website requirements and return this variable. You can modify the $null variable conditionally too if you want.
        return $null;
    }
    // add the filter
    add_filter("image_resize_dimensions", "weplugins_modify_image_resize_dimensions_defaults", 10, 6);
    

Example 2: Custom Conditional Resize

Here is how you can add custom conditions to override the default image resize dimensions.

    add_filter('image_resize_dimensions', 'weplugins_custom_image_resize_dimensions', 10, 6);
    function weplugins_custom_image_resize_dimensions($payload, $orig_w, $orig_h, $dest_w, $dest_h, $crop) {
        // Change this to a conditional that decides whether you want to override the defaults for this image or not.
        if (false) return $payload;
        if ($crop) {
            // Your custom logic here
        }
    }
    

Example 3: Removing a Hook Callback

To remove a hook callback, use the example below. Make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.

    remove_filter("image_resize_dimensions", "weplugins_modify_image_resize_dimensions_defaults", 10, 6);
    

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.