wppaste
WordPress

WP_Image_Editor_Imagick::multi_resize( array $sizes ): array

Since
3.5.0
Source
wp-includes/class-wp-image-editor-imagick.php:790
Create multiple smaller images from a single source.

Description

Attempts to create all sub-sizes and returns the meta data at the end. This may result in the server running out of resources. When it fails there may be few "orphaned" images left over as the meta data is never returned and saved.

As of 5.3.0 the preferred way to do this is with make_subsize(). It creates the new images one at a time and allows for the meta data to be saved after each new image is created.

Compatibility

WordPress
since 3.5.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$sizesarray
An array of image size data arrays. 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. @type array ...$0 { Array of height, width values, and whether to crop.

  • $widthint

    Image width. Optional if $height is specified.

  • $heightint

    Image height. Optional if $width is specified.

  • $cropbool|arraydefault: false. }

    Optional. Whether to crop the image.

Return value

array
An array of resized images' metadata by size.

Performance profile

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

Touches nothing outside its own arguments.

Scaling
Scales with input

The body loops, so the work grows with what you pass in.

Instructions
5–6

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

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

What one call costs · 1 distinct outcome

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

WhenInstructionsCalls it makes
always5–6none

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 18 instructions, 5–6 executed per call, 3 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 2

Source code

View on Trac View on GitHub 

	public function multi_resize( $sizes ) {		$metadata = array(); 		foreach ( $sizes as $size => $size_data ) {			$meta = $this->make_subsize( $size_data ); 			if ( ! is_wp_error( $meta ) ) {				$metadata[ $size ] = $meta;			}		} 		return $metadata;	}

Changelog

Introduced in 3.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 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.