image_resize_dimensions WordPress Filter Hook
The image_resize_dimensions hook is used to alter the dimensions of an image being resized. This can be useful for making sure that an image fits within a specific space, or for ensuring that an image is a certain size when it is being displayed.
apply_filters( 'image_resize_dimensions', null|mixed $null , int $orig_w , int $orig_h , int $dest_w , int $dest_h , bool|array $crop ) #
Filters whether to preempt calculating the image resize dimensions.
Description
Returning a non-null value from the filter will effectively short-circuit image_resize_dimensions(), returning that value instead.
Parameters
- $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.
More Information
- Since version 3.4, the
image_resize_dimensionsfilter is used to filter the thumbnail and alternative sizes dimensions of image assets during resizing operations. This enables the override of WordPress default behavior on image resizing, including the thumbnail cropping. - Note that the filter function must return an array matching the parameters to
imagecopyresampled(), orfalseif the resizing is impossible, or should not occur, ornullto fallback to WordPress default behavior.
Source
File: wp-includes/media.php
Changelog
| Version | Description |
|---|---|
| 3.4.0 | Introduced. |