W3cubDocs

/WordPress

Custom_Image_Header::ajax_header_crop()

Gets attachment uploaded by Media Manager, crops it, then saves it as a new object. Returns JSON-encoded object details.

Source

File: wp-admin/includes/class-custom-image-header.php 

public function ajax_header_crop() {
		check_ajax_referer( 'image_editor-' . $_POST['id'], 'nonce' );

		if ( ! current_user_can( 'edit_theme_options' ) ) {
			wp_send_json_error();
		}

		if ( ! current_theme_supports( 'custom-header', 'uploads' ) ) {
			wp_send_json_error();
		}

		$crop_details = $_POST['cropDetails'];

		$dimensions = $this->get_header_dimensions(
			array(
				'height' => $crop_details['height'],
				'width'  => $crop_details['width'],
			)
		);

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

		$cropped = wp_crop_image(
			$attachment_id,
			(int) $crop_details['x1'],
			(int) $crop_details['y1'],
			(int) $crop_details['width'],
			(int) $crop_details['height'],
			(int) $dimensions['dst_width'],
			(int) $dimensions['dst_height']
		);

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

		/** 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 = $this->create_attachment_object( $cropped, $attachment_id );

		$previous = $this->get_previous_crop( $object );

		if ( $previous ) {
			$object['ID'] = $previous;
		} else {
			unset( $object['ID'] );
		}

		$new_attachment_id = $this->insert_attachment( $object, $cropped );

		$object['attachment_id'] = $new_attachment_id;
		$object['url']           = wp_get_attachment_url( $new_attachment_id );

		$object['width']  = $dimensions['dst_width'];
		$object['height'] = $dimensions['dst_height'];

		wp_send_json_success( $object );
	}

Uses

Uses Description
wp-admin/includes/class-custom-image-header.php: Custom_Image_Header::get_previous_crop()

Get the ID of a previous crop from the same base image.
wp-admin/includes/image.php: wp_crop_image()

Crops an image to a given size.
wp-admin/includes/class-custom-image-header.php: Custom_Image_Header::get_header_dimensions()

Calculate width and height based on what the currently selected theme supports.
wp-admin/includes/class-custom-image-header.php: Custom_Image_Header::create_attachment_object()

Create an attachment ‘object’.
wp-admin/includes/class-custom-image-header.php: Custom_Image_Header::insert_attachment()

Insert an attachment and its metadata.
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/theme.php: current_theme_supports()

Checks a theme’s support for a given feature.
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/pluggable.php: check_ajax_referer()

Verifies the Ajax request to prevent processing requests external of the blog.
wp-includes/functions.php: wp_send_json_error()

Send a JSON response back to an Ajax request, indicating failure.
wp-includes/functions.php: absint()

Convert a value to non-negative integer.
wp-includes/functions.php: wp_send_json_success()

Send a JSON response back to an Ajax request, indicating success.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.
wp-includes/post.php: wp_get_attachment_url()

Retrieve the URL for an attachment.
wp-includes/load.php: is_wp_error()

Check whether variable is a WordPress Error.

Changelog

Version Description
3.9.0 Introduced.

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