How to use big_image_size_threshold filter in WordPress

big_image_size_threshold filter

If the original image width or height is above the threshold, it will be scaled down. The threshold is used as max width and max height. The scaled down image will be used as the largest available size, including the _wp_attached_file post meta value.

To use big_image_size_threshold 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_big_image_size_threshold_defaults which takes 4 parameters and we registered using add_filter. The first parameter big_image_size_threshold is name of the hook, The second parameter modify_big_image_size_threshold_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 big_image_size_threshold filter.

Parameters

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

• $threshold : (int) The threshold value in pixels. Default 2560.
• $imagesize : (array) Indexed array of the image width and height in pixels.
  (int) The image width.
  ‘1’
  (int) The image height.
• $file : (string) Full path to the uploaded image file.
• $attachment_id : (int) Attachment post ID.

Live Example

// completely disable image size threshold
add_filter( 'big_image_size_threshold', '__return_false' );
 // increase the image size threshold to 4000px
function mynamespace_big_image_size_threshold( $threshold ) {
    return 4000; // new threshold
}
add_filter('big_image_size_threshold', 'mynamespace_big_image_size_threshold', 999, 1);

Below is an example how you can use this hook.

                        function modify_big_image_size_threshold_defaults($threshold, $imagesize, $file, $attachment_id) { 
   
                            // Update the $threshold variable according to your website requirements and return this variable. You can modify the $threshold variable conditionally too if you want.

                            return $threshold; 
                        }
                        // add the filter
                        add_filter( "big_image_size_threshold", "modify_big_image_size_threshold_defaults", 10, 4 );

To remove a hook callback, use the example below.

remove_filter( "big_image_size_threshold", "modify_big_image_size_threshold_defaults", 10, 4 );

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.