wp_ajax_crop_image()

Compatibility

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

Performance profile

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

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

86–126

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

Plugin surface

4 hooks

Third-party callbacks on 'wp_create_file_in_uploads', 'wp_ajax_crop_image_pre_save', 'wp_ajax_cropped_attachment_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

• hookthird-party callbacksapply_filters()called directly
• querycontent queryget_post()one call below wp_ajax_crop_image()

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

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

Hooks and filters fired · 5

5 hooks fire while wp_ajax_crop_image() runs, in this order:

1. 1
   apply_filters( wp_create_file_in_uploads )filterline 4043 (+34 into the body)

   Filters the attachment file path after the custom header or background image is set.

2. 2
   do_action( wp_ajax_crop_image_pre_save )actionline 4069 (+60 into the body)

   Fires before a cropped image is saved.

3. 3
   apply_filters( wp_create_file_in_uploads )filterline 4072 (+63 into the body)

   Filters the attachment file path after the custom header or background image is set.

4. 4
   apply_filters( wp_ajax_cropped_attachment_metadata )filterline 4089 (+80 into the body)

   Filters the cropped image attachment metadata.

5. 5
   apply_filters( wp_ajax_cropped_attachment_id )filterline 4100 (+91 into the body)

   Filters the attachment ID for a cropped image.

Uses · 20

• absint()Converts a value to non-negative integer.
• check_ajax_referer()Verifies the Ajax request to prevent processing requests external of the blog.
• current_user_can()Returns whether the current user has the specified capability.
• wp_send_json_error()Sends a JSON response back to an Ajax request, indicating failure.
• wp_crop_image()Crops an image to a given size.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• __()Retrieves the translation of $text.
• get_post_meta()Retrieves a post meta field for the given post ID.
• wp_delete_file()Deletes a file.
• add_filter()Adds a callback function to a filter hook.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_copy_parent_attachment_properties()Copy parent attachment properties to newly cropped image.

Source code

View on Trac ↗View on GitHub ↗

4009function wp_ajax_crop_image() {4010	$attachment_id = absint( $_POST['id'] );4011 4012	check_ajax_referer( 'image_editor-' . $attachment_id, 'nonce' );4013 4014	if ( empty( $attachment_id ) || ! current_user_can( 'edit_post', $attachment_id ) ) {4015		wp_send_json_error();4016	}4017 4018	$context = str_replace( '_', '-', $_POST['context'] );4019	$data    = array_map( 'absint', $_POST['cropDetails'] );4020	$cropped = wp_crop_image( $attachment_id, $data['x1'], $data['y1'], $data['width'], $data['height'], $data['dst_width'], $data['dst_height'] );4021 4022	if ( ! $cropped || is_wp_error( $cropped ) ) {4023		wp_send_json_error( array( 'message' => __( 'Image could not be processed.' ) ) );4024	}4025 4026	switch ( $context ) {4027		case 'site-icon':4028			require_once ABSPATH . 'wp-admin/includes/class-wp-site-icon.php';4029			$wp_site_icon = new WP_Site_Icon();4030 4031			// Skip creating a new attachment if the attachment is a Site Icon.4032			if ( get_post_meta( $attachment_id, '_wp_attachment_context', true ) === $context ) {4033 4034				// Delete the temporary cropped file, we don't need it.4035				wp_delete_file( $cropped );4036 4037				// Additional sizes in wp_prepare_attachment_for_js().4038				add_filter( 'image_size_names_choose', array( $wp_site_icon, 'additional_sizes' ) );4039				break;4040			}4041 4042			/** This filter is documented in wp-admin/includes/class-custom-image-header.php */4043			$cropped = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication.4044 4045			// Copy attachment properties.4046			$attachment = wp_copy_parent_attachment_properties( $cropped, $attachment_id, $context );4047 4048			// Update the attachment.4049			add_filter( 'intermediate_image_sizes_advanced', array( $wp_site_icon, 'additional_sizes' ) );4050			$attachment_id = $wp_site_icon->insert_attachment( $attachment, $cropped );4051			remove_filter( 'intermediate_image_sizes_advanced', array( $wp_site_icon, 'additional_sizes' ) );4052 4053			// Additional sizes in wp_prepare_attachment_for_js().4054			add_filter( 'image_size_names_choose', array( $wp_site_icon, 'additional_sizes' ) );4055			break;4056 4057		default:4058			/**4059			 * Fires before a cropped image is saved.4060			 *4061			 * Allows to add filters to modify the way a cropped image is saved.4062			 *4063			 * @since 4.3.04064			 *4065			 * @param string $context       The Customizer control requesting the cropped image.4066			 * @param int    $attachment_id The attachment ID of the original image.4067			 * @param string $cropped       Path to the cropped image file.4068			 */4069			do_action( 'wp_ajax_crop_image_pre_save', $context, $attachment_id, $cropped );4070 4071			/** This filter is documented in wp-admin/includes/class-custom-image-header.php */4072			$cropped = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication.4073 4074			// Copy attachment properties.4075			$attachment = wp_copy_parent_attachment_properties( $cropped, $attachment_id, $context );4076 4077			$attachment_id = wp_insert_attachment( $attachment, $cropped );4078			$metadata      = wp_generate_attachment_metadata( $attachment_id, $cropped );4079 4080			/**4081			 * Filters the cropped image attachment metadata.4082			 *4083			 * @since 4.3.04084			 *4085			 * @see wp_generate_attachment_metadata()4086			 *4087			 * @param array $metadata Attachment metadata.4088			 */

Changelog

Introduced in 4.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-admin/includes/ajax-actions.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.