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

Description

Parameters

$filestring

Image file path.

$max_wint

Maximum width to resize to.

$max_hint

Maximum height to resize to.

$cropbooloptional

Whether to crop image or resize. Default false.Default: false

$suffixstringoptional

File suffix. Default null.Default: null

$dest_pathstringoptional

New image file path. Default null.Default: null

$jpeg_qualityintoptional

Image quality percentage. Default 90.Default: 90

Return

mixed

WP_Error on failure. String with new destination path.

Uses · 3

• _deprecated_function()Marks a function as deprecated and inform when it has been used.
• wp_get_image_editor()Returns a WP_Image_Editor instance and loads file into it.
• is_wp_error()Checks whether the given variable is a WordPress Error.

Used by · 1

• wp_create_thumbnail()This was once used to create a thumbnail from an Image given a maximum side size.

Source

View on Trac ↗View on GitHub ↗

3253function image_resize( $file, $max_w, $max_h, $crop = false, $suffix = null, $dest_path = null, $jpeg_quality = 90 ) {3254	_deprecated_function( __FUNCTION__, '3.5.0', 'wp_get_image_editor()' );3255 3256	$editor = wp_get_image_editor( $file );3257	if ( is_wp_error( $editor ) )3258		return $editor;3259	$editor->set_quality( $jpeg_quality );3260 3261	$resized = $editor->resize( $max_w, $max_h, $crop );3262	if ( is_wp_error( $resized ) )3263		return $resized;3264 3265	$dest_file = $editor->generate_filename( $suffix, $dest_path );3266	$saved = $editor->save( $dest_file );3267 3268	if ( is_wp_error( $saved ) )3269		return $saved;3270 3271	return $dest_file;3272}

History

Introduced in 2.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/deprecated.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.