WP_REST_Attachments_Controller::edit_media_item( WP_REST_Request $request ): WP_REST_Response|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

$requestWP_REST_Request

Full details about the request.

Return value

WP_REST_Response|WP_Error

Response object on success, WP_Error object on failure.

Performance profile

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

Heavy

Reads or writes the filesystem via file_exists().

Scaling

Scales with input

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

Instructions

24–268

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

Plugin surface

1 hook

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

Called by

0

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

What it touches

• querycontent queryget_post()called directly
• hookthird-party callbacksapply_filters()called directly
• filesystemfilesystem accessfile_exists()called directly

Further down the call graph this can also reach cache, option, 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 · 10 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 1

One hook fires while WP_REST_Attachments_Controller::edit_media_item() runs, in this order:

1. 1
   apply_filters( wp_edited_image_metadata )filterline 1368 (+282 into the body)

   Filters the meta data for the new image created by editing an existing image.

Uses · 26

• wp_get_original_image_path()Retrieves the path to an uploaded image file.
• wp_get_attachment_metadata()Retrieves attachment metadata for attachment ID.
• wp_image_file_matches_image_meta()Determines if the image meta data is for the image source file.
• __()Retrieves the translation of $text.
• get_post_mime_type()Retrieves the mime type of an attachment based on the ID.
• _load_image_to_edit_path()Retrieves the path or URL of an attachment's attached file.
• wp_get_image_editor()Returns a WP_Image_Editor instance and loads file into it.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_basename()i18n-friendly version of basename().
• wp_upload_dir()Returns an array containing the current upload directory's path and URL.
• wp_unique_filename()Gets a filename that is sanitized and unique for the given directory.
• get_post()Retrieves post data given a post ID or post object.

Source code

View on Trac ↗View on GitHub ↗

1086	public function edit_media_item( $request ) {1087		require_once ABSPATH . 'wp-admin/includes/image.php';1088 1089		$attachment_id = $request['id'];1090 1091		// This also confirms the attachment is an image.1092		$image_file = wp_get_original_image_path( $attachment_id );1093		$image_meta = wp_get_attachment_metadata( $attachment_id );1094 1095		if (1096			! $image_meta ||1097			! $image_file ||1098			! wp_image_file_matches_image_meta( $request['src'], $image_meta, $attachment_id )1099		) {1100			return new WP_Error(1101				'rest_unknown_attachment',1102				__( 'Unable to get meta information for file.' ),1103				array( 'status' => 404 )1104			);1105		}1106 1107		$supported_types = array( 'image/jpeg', 'image/png', 'image/gif', 'image/webp', 'image/avif', 'image/heic' );1108		$mime_type       = get_post_mime_type( $attachment_id );1109		if ( ! in_array( $mime_type, $supported_types, true ) ) {1110			return new WP_Error(1111				'rest_cannot_edit_file_type',1112				__( 'This type of file cannot be edited.' ),1113				array( 'status' => 400 )1114			);1115		}1116 1117		// The `modifiers` param takes precedence over the older format.1118		if ( isset( $request['modifiers'] ) ) {1119			$modifiers = $request['modifiers'];1120		} else {1121			$modifiers = array();1122 1123			if ( isset( $request['flip']['horizontal'] ) || isset( $request['flip']['vertical'] ) ) {1124				$flip_args = array(1125					'vertical'   => isset( $request['flip']['vertical'] ) ? (bool) $request['flip']['vertical'] : false,1126					'horizontal' => isset( $request['flip']['horizontal'] ) ? (bool) $request['flip']['horizontal'] : false,1127				);1128 1129				$modifiers[] = array(1130					'type' => 'flip',1131					'args' => array(1132						'flip' => $flip_args,1133					),1134				);1135			}1136 1137			if ( ! empty( $request['rotation'] ) ) {1138				$modifiers[] = array(1139					'type' => 'rotate',1140					'args' => array(1141						'angle' => $request['rotation'],1142					),1143				);1144			}1145 1146			if ( isset( $request['x'], $request['y'], $request['width'], $request['height'] ) ) {1147				$modifiers[] = array(1148					'type' => 'crop',1149					'args' => array(1150						'left'   => $request['x'],1151						'top'    => $request['y'],1152						'width'  => $request['width'],1153						'height' => $request['height'],1154					),1155				);1156			}1157 1158			if ( 0 === count( $modifiers ) ) {1159				return new WP_Error(1160					'rest_image_not_edited',1161					__( 'The image was not edited. Edit the image before applying the changes.' ),1162					array( 'status' => 400 )1163				);1164			}1165		}

Changelog

Introduced in 5.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 7.1.0 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.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.