Filters the “BIG image” threshold value.
Description
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.
Returning false
from the filter callback will disable the scaling.
Parameters
$threshold
int- The threshold value in pixels. Default 2560.
$imagesize
array- Indexed array of the image width and height in pixels.
0
intThe image width.1
intThe image height.
$file
string- Full path to the uploaded image file.
$attachment_id
int- Attachment post ID.
Source
$threshold = (int) apply_filters( 'big_image_size_threshold', 2560, $imagesize, $file, $attachment_id );
Changelog
Version | Description |
---|---|
5.3.0 | Introduced. |
Usage examples:
__return_false
is a function name, andadd_filter()
is a function that expects a callable (in this case, a function name) for the second parameter, so it is correct to provide__return_false
as a string.