WP_Image_Editor::resize() │ public │ WP 3.5.0

Resizes current image.

At minimum, either a height or width must be provided. If one of the two is set to null, the resize will maintain aspect ratio according to the provided dimension.

Method of the class: WP_Image_Editor{}

No Hooks.

Return

true|WP_Error.

Usage

$WP_Image_Editor = new WP_Image_Editor();
$WP_Image_Editor->resize( $max_w, $max_h, $crop );
$max_w(int|null) (required)
Image width.
$max_h(int|null) (required)
Image height.
$crop(true|false|array)

Image cropping behavior. If false, the image will be scaled (default). If true, image will be cropped to the specified dimensions using center positions. If an array, the image will be cropped using the array to specify the crop location:

Default: false

  • 0(string)
    The x crop position. Accepts 'left' 'center', or 'right'.

  • 1(string)
    The y crop position. Accepts 'top', 'center', or 'bottom'.

Changelog

Since 3.5.0 Introduced.

WP_Image_Editor::resize() code WP 6.4.1

wp-includes/class-wp-image-editor.php 
abstract public function resize( $max_w, $max_h, $crop = false );