Warning: This function has been deprecated. Use wp_get_image_editor() instead.

image_resize ( string $file, int $max_w, int $max_h, bool $crop = false, string $suffix = null, string $dest_path = null, int $jpeg_quality = 90 )

Scale down an image to fit a particular size and save a new copy of the image.

The PNG transparency will be preserved using the function, as well as the image type. If the file going in is PNG, then the resized image is going to be PNG. The only supported image types are PNG, GIF, and JPEG.

Some functionality requires API to exist, so some PHP version may lose out support. This is not the fault of WordPress (where functionality is downgraded, not actual defects), but of your PHP version.

Return: (mixed) WP_Error on failure. String with new destination path.

Source file: wp-includes/deprecated.php

View source


Parameters

$file

(string) (Required) Image file path.

$max_w

(int) (Required) Maximum width to resize to.

$max_h

(int) (Required) Maximum height to resize to.

$crop

(bool) (Optional) Whether to crop image or resize.

Default value: false

$suffix

(string) (Optional) File suffix.

Default value: null

$dest_path

(string) (Optional) New image file path.

Default value: null

$jpeg_quality

(int) (Optional) Image quality percentage.

Default value: 90



Source

function image_resize( $file, $max_w, $max_h, $crop = false, $suffix = null, $dest_path = null, $jpeg_quality = 90 ) {
	_deprecated_function( __FUNCTION__, '3.5', 'wp_get_image_editor()' );

	$editor = wp_get_image_editor( $file );
	if ( is_wp_error( $editor ) )
		return $editor;
	$editor->set_quality( $jpeg_quality );

	$resized = $editor->resize( $max_w, $max_h, $crop );
	if ( is_wp_error( $resized ) )
		return $resized;

	$dest_file = $editor->generate_filename( $suffix, $dest_path );
	$saved = $editor->save( $dest_file );

	if ( is_wp_error( $saved ) )
		return $saved;

	return $dest_file;
}


Changelog


User Contributed Notes

You must log in before being able to contribute a note.