image_edit_apply_changes( WP_Image_Editor $image, array $changes ): WP_Image_Editor

Compatibility

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

Parameters

$imageWP_Image_Editor

WP_Image_Editor instance.

$changesarray

Array of change operations.

Return value

WP_Image_Editor

WP_Image_Editor instance with changes applied.

Performance profile

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

9–56

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

Plugin surface

2 hooks

Third-party callbacks on 'wp_image_editor_before_change', 'image_edit_before_change' run inside this call, and their cost is not bounded by anything here.

Called by

2

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

What it touches

• hookthird-party callbacksapply_filters()called directly

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 · 6 distinct outcomes

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

Hooks and filters fired · 2

2 hooks fire while image_edit_apply_changes() runs, in this order:

1. 1
   apply_filters( wp_image_editor_before_change )filterline 695 (+69 into the body)

   Filters the WP_Image_Editor instance before applying changes to the image.

2. 2
   do_action( image_edit_before_change )filter_deprecatedline 707 (+81 into the body)

   Filters the GD image resource before applying changes to the image.

Uses · 9

• is_gd_image()Determines whether the value is an acceptable type for GD image functions.
• _deprecated_argument()Marks a function argument as deprecated and inform when it has been used.
• __()Retrieves the translation of $text.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• apply_filters_deprecated()Fires functions attached to a deprecated filter hook.
• _rotate_image_resource()Returns an image resource. Internal use only.
• _flip_image_resource()Flips an image resource. Internal use only.
• _image_get_preview_ratio()Image preview ratio. Internal use only.
• _crop_image_resource()Crops an image resource. Internal use only.

Used by · 2

• stream_preview_image()Streams image in post to browser, along with enqueued changes in `$_REQUEST['history']`.
• wp_save_image()Saves image to post, along with enqueued changes in `$_REQUEST['history']`.

Source code

View on Trac ↗View on GitHub ↗

626function image_edit_apply_changes( $image, $changes ) {627	if ( is_gd_image( $image ) ) {628		/* translators: 1: $image, 2: WP_Image_Editor */629		_deprecated_argument( __FUNCTION__, '3.5.0', sprintf( __( '%1$s needs to be a %2$s object.' ), '$image', 'WP_Image_Editor' ) );630	}631 632	if ( ! is_array( $changes ) ) {633		return $image;634	}635 636	// Expand change operations.637	foreach ( $changes as $key => $obj ) {638		if ( isset( $obj->r ) ) {639			$obj->type  = 'rotate';640			$obj->angle = $obj->r;641			unset( $obj->r );642		} elseif ( isset( $obj->f ) ) {643			$obj->type = 'flip';644			$obj->axis = $obj->f;645			unset( $obj->f );646		} elseif ( isset( $obj->c ) ) {647			$obj->type = 'crop';648			$obj->sel  = $obj->c;649			unset( $obj->c );650		}651 652		$changes[ $key ] = $obj;653	}654 655	// Combine operations.656	if ( count( $changes ) > 1 ) {657		$filtered = array( $changes[0] );658 659		for ( $i = 0, $j = 1, $c = count( $changes ); $j < $c; $j++ ) {660			$combined = false;661 662			if ( $filtered[ $i ]->type === $changes[ $j ]->type ) {663				switch ( $filtered[ $i ]->type ) {664					case 'rotate':665						$filtered[ $i ]->angle += $changes[ $j ]->angle;666						$combined               = true;667						break;668					case 'flip':669						$filtered[ $i ]->axis ^= $changes[ $j ]->axis;670						$combined              = true;671						break;672				}673			}674 675			if ( ! $combined ) {676				$filtered[ ++$i ] = $changes[ $j ];677			}678		}679 680		$changes = $filtered;681		unset( $filtered );682	}683 684	// Image resource before applying the changes.685	if ( $image instanceof WP_Image_Editor ) {686 687		/**688		 * Filters the WP_Image_Editor instance before applying changes to the image.689		 *690		 * @since 3.5.0691		 *692		 * @param WP_Image_Editor $image   WP_Image_Editor instance.693		 * @param array           $changes Array of change operations.694		 */695		$image = apply_filters( 'wp_image_editor_before_change', $image, $changes );696	} elseif ( is_gd_image( $image ) ) {697 698		/**699		 * Filters the GD image resource before applying changes to the image.700		 *701		 * @since 2.9.0702		 * @deprecated 3.5.0 Use {@see 'wp_image_editor_before_change'} instead.703		 *704		 * @param resource|GdImage $image   GD image resource or GdImage instance.705		 * @param array            $changes Array of change operations.

Changelog

Introduced in 2.9.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.7.7 tag, from src/wp-admin/includes/image-edit.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.