WP_Image_Editor_Imagick::make_subsize( array $size_data ): array|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

$size_dataarray

Array of size data.

• $widthint

  The maximum width in pixels.

• $heightint

  The maximum height in pixels.

• $cropbool|array

  Whether to crop the image to exact dimensions.

Return value

array|WP_Error

The image data array for inclusion in the sizes array in the image meta, WP_Error object on error.

Performance profile

How much work a call to WP_Image_Editor_Imagick::make_subsize() 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

13–72

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

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

What it touches

• hookthird-party callbacksdo_action()one call below WP_Image_Editor_Imagick::make_subsize()

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 4 distinct outcomes

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

Uses · 5

• __()Retrieves the translation of $text.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• WP_Error::__construct()Initializes the error.
• WP_Image_Editor_Imagick::resize()Resizes current image.
• WP_Image_Editor_Imagick::_save()

Used by · 1

• WP_Image_Editor_Imagick::multi_resize()Create multiple smaller images from a single source.

Source code

View on Trac ↗View on GitHub ↗

819	public function make_subsize( $size_data ) {820		if ( ! isset( $size_data['width'] ) && ! isset( $size_data['height'] ) ) {821			return new WP_Error( 'image_subsize_create_error', __( 'Cannot resize the image. Both width and height are not set.' ) );822		}823 824		$orig_size  = $this->size;825		$orig_image = $this->image->getImage();826 827		if ( ! isset( $size_data['width'] ) ) {828			$size_data['width'] = null;829		}830 831		if ( ! isset( $size_data['height'] ) ) {832			$size_data['height'] = null;833		}834 835		if ( ! isset( $size_data['crop'] ) ) {836			$size_data['crop'] = false;837		}838 839		if ( ( $this->size['width'] === $size_data['width'] ) && ( $this->size['height'] === $size_data['height'] ) ) {840			return new WP_Error( 'image_subsize_create_error', __( 'The image already has the requested size.' ) );841		}842 843		$resized = $this->resize( $size_data['width'], $size_data['height'], $size_data['crop'] );844 845		if ( is_wp_error( $resized ) ) {846			$saved = $resized;847		} else {848			$saved = $this->_save( $this->image );849 850			$this->image->clear();851			$this->image->destroy();852			$this->image = null;853		}854 855		$this->size  = $orig_size;856		$this->image = $orig_image;857 858		if ( ! is_wp_error( $saved ) ) {859			unset( $saved['path'] );860		}861 862		return $saved;863	}

Changelog

Introduced in 5.3.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 6.8.8 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.