W3cubDocs

/WordPress

wp_ajax_crop_image()

Ajax handler for cropping an image.

Source

File: wp-admin/includes/ajax-actions.php

function wp_ajax_crop_image() {
	$attachment_id = absint( $_POST['id'] );

	check_ajax_referer( 'image_editor-' . $attachment_id, 'nonce' );

	if ( empty( $attachment_id ) || ! current_user_can( 'edit_post', $attachment_id ) ) {
		wp_send_json_error();
	}

	$context = str_replace( '_', '-', $_POST['context'] );
	$data    = array_map( 'absint', $_POST['cropDetails'] );
	$cropped = wp_crop_image( $attachment_id, $data['x1'], $data['y1'], $data['width'], $data['height'], $data['dst_width'], $data['dst_height'] );

	if ( ! $cropped || is_wp_error( $cropped ) ) {
		wp_send_json_error( array( 'message' => __( 'Image could not be processed.' ) ) );
	}

	switch ( $context ) {
		case 'site-icon':
			require_once ABSPATH . 'wp-admin/includes/class-wp-site-icon.php';
			$wp_site_icon = new WP_Site_Icon();

			// Skip creating a new attachment if the attachment is a Site Icon.
			if ( get_post_meta( $attachment_id, '_wp_attachment_context', true ) == $context ) {

				// Delete the temporary cropped file, we don't need it.
				wp_delete_file( $cropped );

				// Additional sizes in wp_prepare_attachment_for_js().
				add_filter( 'image_size_names_choose', array( $wp_site_icon, 'additional_sizes' ) );
				break;
			}

			/** This filter is documented in wp-admin/includes/class-custom-image-header.php */
			$cropped = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication.
			$object  = $wp_site_icon->create_attachment_object( $cropped, $attachment_id );
			unset( $object['ID'] );

			// Update the attachment.
			add_filter( 'intermediate_image_sizes_advanced', array( $wp_site_icon, 'additional_sizes' ) );
			$attachment_id = $wp_site_icon->insert_attachment( $object, $cropped );
			remove_filter( 'intermediate_image_sizes_advanced', array( $wp_site_icon, 'additional_sizes' ) );

			// Additional sizes in wp_prepare_attachment_for_js().
			add_filter( 'image_size_names_choose', array( $wp_site_icon, 'additional_sizes' ) );
			break;

		default:
			/**
			 * Fires before a cropped image is saved.
			 *
			 * Allows to add filters to modify the way a cropped image is saved.
			 *
			 * @since 4.3.0
			 *
			 * @param string $context       The Customizer control requesting the cropped image.
			 * @param int    $attachment_id The attachment ID of the original image.
			 * @param string $cropped       Path to the cropped image file.
			 */
			do_action( 'wp_ajax_crop_image_pre_save', $context, $attachment_id, $cropped );

			/** This filter is documented in wp-admin/includes/class-custom-image-header.php */
			$cropped = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication.

			$parent_url = wp_get_attachment_url( $attachment_id );
			$url        = str_replace( wp_basename( $parent_url ), wp_basename( $cropped ), $parent_url );

			$size       = @getimagesize( $cropped );
			$image_type = ( $size ) ? $size['mime'] : 'image/jpeg';

			$object = array(
				'post_title'     => wp_basename( $cropped ),
				'post_content'   => $url,
				'post_mime_type' => $image_type,
				'guid'           => $url,
				'context'        => $context,
			);

			$attachment_id = wp_insert_attachment( $object, $cropped );
			$metadata      = wp_generate_attachment_metadata( $attachment_id, $cropped );

			/**
			 * Filters the cropped image attachment metadata.
			 *
			 * @since 4.3.0
			 *
			 * @see wp_generate_attachment_metadata()
			 *
			 * @param array $metadata Attachment metadata.
			 */
			$metadata = apply_filters( 'wp_ajax_cropped_attachment_metadata', $metadata );
			wp_update_attachment_metadata( $attachment_id, $metadata );

			/**
			 * Filters the attachment ID for a cropped image.
			 *
			 * @since 4.3.0
			 *
			 * @param int    $attachment_id The attachment ID of the cropped image.
			 * @param string $context       The Customizer control requesting the cropped image.
			 */
			$attachment_id = apply_filters( 'wp_ajax_cropped_attachment_id', $attachment_id, $context );
	}

	wp_send_json_success( wp_prepare_attachment_for_js( $attachment_id ) );
}

Uses

Uses	Description
wp-admin/includes/class-wp-site-icon.php: WP_Site_Icon::__construct()	Registers actions and filters.
wp-admin/includes/class-wp-site-icon.php: WP_Site_Icon::create_attachment_object()	Creates an attachment ‘object’.
wp-admin/includes/class-wp-site-icon.php: WP_Site_Icon::insert_attachment()	Inserts an attachment.
wp-admin/includes/ajax-actions.php: wp_ajax_crop_image_pre_save	Fires before a cropped image is saved.
wp-admin/includes/ajax-actions.php: wp_ajax_cropped_attachment_metadata	Filters the cropped image attachment metadata.
wp-admin/includes/ajax-actions.php: wp_ajax_cropped_attachment_id	Filters the attachment ID for a cropped image.
wp-includes/functions.php: wp_delete_file()	Delete a file
wp-admin/includes/image.php: wp_generate_attachment_metadata()	Generate attachment meta data and create image sub-sizes for images.
wp-admin/includes/image.php: wp_crop_image()	Crops an image to a given size.
wp-admin/includes/class-custom-image-header.php: wp_create_file_in_uploads	Fires after the header image is set or an error is returned.
wp-includes/capabilities.php: current_user_can()	Returns whether the current user has the specified capability.
wp-includes/l10n.php: __()	Retrieve the translation of $text.
wp-includes/formatting.php: wp_basename()	i18n friendly version of basename()
wp-includes/pluggable.php: check_ajax_referer()	Verifies the Ajax request to prevent processing requests external of the blog.
wp-includes/functions.php: absint()	Convert a value to non-negative integer.
wp-includes/functions.php: wp_send_json_error()	Send a JSON response back to an Ajax request, indicating failure.
wp-includes/functions.php: wp_send_json_success()	Send a JSON response back to an Ajax request, indicating success.
wp-includes/plugin.php: add_filter()	Hook a function or method to a specific filter action.
wp-includes/plugin.php: remove_filter()	Removes a function from a specified filter hook.
wp-includes/plugin.php: apply_filters()	Calls the callback functions that have been added to a filter hook.
wp-includes/plugin.php: do_action()	Execute functions hooked on a specific action hook.
wp-includes/media.php: wp_prepare_attachment_for_js()	Prepares an attachment post object for JS, where it is expected to be JSON-encoded and fit into an Attachment model.
wp-includes/post.php: wp_get_attachment_url()	Retrieve the URL for an attachment.
wp-includes/post.php: wp_insert_attachment()	Insert an attachment.
wp-includes/post.php: wp_update_attachment_metadata()	Updates metadata for an attachment.
wp-includes/post.php: get_post_meta()	Retrieves a post meta field for the given post ID.
wp-includes/load.php: is_wp_error()	Check whether variable is a WordPress Error.

Changelog

Version	Description
4.3.0	Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_ajax_crop_image

wp_ajax_crop_image()

Source

Related

Uses

Changelog