WP_Image_Editor_Imagick::update_size( int $width = null, int $height = null ): true|WP_Error

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$widthintoptional

Default: null

$heightintoptional

Default: null

Return value

true|WP_Error

Performance profile

How much work a call to WP_Image_Editor_Imagick::update_size() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

14–42

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 54.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

4

4 places in core call this, so the cost is paid more often than your own code shows.

What one call costs · 8 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Image_Editor_Imagick::update_size() can have, taken from its control-flow graph on PHP 8.5.

Uses · 5

• __()Retrieves the translation of $text.
• wp_is_heic_image_mime_type()Checks if a mime type is for a HEIC/HEIF image.
• wp_getimagesize()Allows PHP's getimagesize() to be debuggable when necessary.
• WP_Error::__construct()Initializes the error.
• WP_Image_Editor::update_size()Sets current image size.

Used by · 4

• WP_Image_Editor_Imagick::crop()Crops Image.
• WP_Image_Editor_Imagick::load()Loads image from $this->file into new Imagick Object.
• WP_Image_Editor_Imagick::resize()Resizes current image.
• WP_Image_Editor_Imagick::rotate()Rotates current image counter-clockwise by $angle.

Source code

View on Trac ↗View on GitHub ↗

452	protected function update_size( $width = null, $height = null ) {453		$size = null;454		if ( ! $width || ! $height ) {455			try {456				$size = $this->image->getImageGeometry();457			} catch ( Exception $e ) {458				return new WP_Error( 'invalid_image', __( 'Could not read image size.' ), $this->file );459			}460		}461 462		if ( ! $width ) {463			$width = $size['width'];464		}465 466		if ( ! $height ) {467			$height = $size['height'];468		}469 470		/*471		 * If we still don't have the image size, fall back to `wp_getimagesize`. This ensures AVIF and HEIC images472		 * are properly sized without affecting previous `getImageGeometry` behavior.473		 */474		if ( ( ! $width || ! $height ) && ( 'image/avif' === $this->mime_type || wp_is_heic_image_mime_type( $this->mime_type ) ) ) {475			$size   = wp_getimagesize( $this->file );476			$width  = $size[0];477			$height = $size[1];478		}479 480		return parent::update_size( $width, $height );481	}

Changelog

Introduced in 3.5.0. 2 changes between 6.7.7 and 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 6.7.7 tag, from src/wp-includes/class-wp-image-editor-imagick.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.