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 Flipper Code, 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 name of the hook, The second parameter modify_image_resize_dimensions_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 image_resize_dimensions filter.

Parameters

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

• $null : (null|mixed) Whether to preempt output of the resize dimensions.
• $orig_w : (int) Original width in pixels.
• $orig_h : (int) Original height in pixels.
• $dest_w : (int) New width in pixels.
• $dest_h : (int) New height in pixels.
• $crop : (bool|array) Whether to crop image to specified width and height or resize. An array can specify positioning of the crop area. Default false.

Live Example

add_filter( 'image_resize_dimensions', 'custom_image_resize_dimensions', 10, 6 );
 function 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 ) {
 , $dest_w, $dest_h );
 , (int) $crop_w, (int) $crop_h );

Below is an example how you can use this hook.

                        function 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", "modify_image_resize_dimensions_defaults", 10, 6 );

To remove a hook callback, use the example below.

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

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

Flipper Code is a Premium WordPress Plugins development company and integrating new functionalites into WordPress sites in form of custom WordPress Plugins since 2012. If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.