WP_Image_Editor_Imagick::crop( int $src_x, int $src_y, int $src_w, int $src_h, int $dst_w = null, int $dst_h = null, bool $src_abs = false ): 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

$src_xint

The start x position to crop from.

$src_yint

The start y position to crop from.

$src_wint

The width to crop.

$src_hint

The height to crop.

$dst_wintoptional

The destination width.Default: null

$dst_hintoptional

The destination height.Default: null

$src_absbooloptional

If the source crop points are absolute.Default: false

Return value

true|WP_Error

Performance profile

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

27–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

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::crop()

What one call costs · 3 distinct outcomes

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

Uses · 4

• is_wp_error()Checks whether the given variable is a WordPress Error.
• WP_Image_Editor_Imagick::thumbnail_image()Efficiently resize the current image
• WP_Image_Editor_Imagick::update_size()Sets or updates current image size.
• WP_Error::__construct()Initializes the error.

Used by · 1

• WP_Image_Editor_Imagick::resize()Resizes current image.

Source code

View on Trac ↗View on GitHub ↗

879	public function crop( $src_x, $src_y, $src_w, $src_h, $dst_w = null, $dst_h = null, $src_abs = false ) {880		if ( $src_abs ) {881			$src_w -= $src_x;882			$src_h -= $src_y;883		}884 885		try {886			$this->image->cropImage( $src_w, $src_h, $src_x, $src_y );887			$this->image->setImagePage( $src_w, $src_h, 0, 0 );888 889			if ( $dst_w || $dst_h ) {890				/*891				 * If destination width/height isn't specified,892				 * use same as width/height from source.893				 */894				if ( ! $dst_w ) {895					$dst_w = $src_w;896				}897				if ( ! $dst_h ) {898					$dst_h = $src_h;899				}900 901				$thumb_result = $this->thumbnail_image( $dst_w, $dst_h );902				if ( is_wp_error( $thumb_result ) ) {903					return $thumb_result;904				}905 906				return $this->update_size();907			}908		} catch ( Exception $e ) {909			return new WP_Error( 'image_crop_error', $e->getMessage() );910		}911 912		return $this->update_size();913	}

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.