WP_Image_Editor_GD::resize( int|null $max_w, int|null $max_h, bool|array $crop = false ): true|WP_Error
Resizes current image.
Description
Wraps ::_resize() which returns a GD resource or GdImage instance.
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.
Parameters
-
$max_wint|null Required -
Image width.
-
$max_hint|null Required -
Image height.
-
$cropbool|array Optional -
Default:
false
Return
true|WP_Error
Source
File: wp-includes/class-wp-image-editor-gd.php.
View all references
public function resize( $max_w, $max_h, $crop = false ) {
if ( ( $this->size['width'] == $max_w ) && ( $this->size['height'] == $max_h ) ) {
return true;
}
$resized = $this->_resize( $max_w, $max_h, $crop );
if ( is_gd_image( $resized ) ) {
imagedestroy( $this->image );
$this->image = $resized;
return true;
} elseif ( is_wp_error( $resized ) ) {
return $resized;
}
return new WP_Error( 'image_resize_error', __( 'Image resize failed.' ), $this->file );
}
Changelog
| Version | Description |
|---|---|
| 3.5.0 | Introduced. |