wp_crop_image( string|int $src, int $src_x, int $src_y, int $src_w, int $src_h, int $dst_w, int $dst_h, int $src_abs = false, string $dst_file = false )

Crop an Image to a given size.

Parameters

$src

(Required) The source file or Attachment ID.

$src_x

(Required) The start x position to crop from.

$src_y

(Required) The start y position to crop from.

$src_w

(Required) The width to crop.

$src_h

(Required) The height to crop.

$dst_w

(Required) The destination width.

$dst_h

(Required) The destination height.

$src_abs

(Optional) If the source crop points are absolute.

Default value: false

$dst_file

(Optional) The destination file to write to.

Default value: false

Return

(string|WP_Error) New filepath on success, WP_Error on failure.

Source

File: wp-admin/includes/image.php

function wp_crop_image( $src, $src_x, $src_y, $src_w, $src_h, $dst_w, $dst_h, $src_abs = false, $dst_file = false ) {
	$src_file = $src;
	if ( is_numeric( $src ) ) { // Handle int as attachment ID
		$src_file = get_attached_file( $src );

		if ( ! file_exists( $src_file ) ) {
			// If the file doesn't exist, attempt a URL fopen on the src link.
			// This can occur with certain file replication plugins.
			$src = _load_image_to_edit_path( $src, 'full' );
		} else {
			$src = $src_file;
		}
	}

	$editor = wp_get_image_editor( $src );
	if ( is_wp_error( $editor ) )
		return $editor;

	$src = $editor->crop( $src_x, $src_y, $src_w, $src_h, $dst_w, $dst_h, $src_abs );
	if ( is_wp_error( $src ) )
		return $src;

	if ( ! $dst_file )
		$dst_file = str_replace( basename( $src_file ), 'cropped-' . basename( $src_file ), $src_file );

	/*
	 * The directory containing the original file may no longer exist when
	 * using a replication plugin.
	 */
	wp_mkdir_p( dirname( $dst_file ) );

	$dst_file = dirname( $dst_file ) . '/' . wp_unique_filename( dirname( $dst_file ), basename( $dst_file ) );

	$result = $editor->save( $dst_file );
	if ( is_wp_error( $result ) )
		return $result;

	return $dst_file;
}

Expand Source Code View on GitHub

Uses

Uses
Uses	Description
wp-includes/media.php: wp_get_image_editor()	Returns a WP_Image_Editor instance and loads file into it.
wp-includes/post.php: get_attached_file()	Retrieve attached file path based on attachment ID.
wp-includes/load.php: is_wp_error()	Check whether variable is a ClassicPress Error.
wp-includes/functions.php: wp_unique_filename()	Get a filename that is sanitized and unique for the given directory.
wp-includes/functions.php: wp_mkdir_p()	Recursive directory creation based on full path.
wp-admin/includes/image.php: _load_image_to_edit_path()	Retrieve the path or url of an attachment’s attached file.

Show 1 more use Hide more uses

Used By

Used By
Used By	Description
wp-admin/custom-header.php: 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.
wp-admin/custom-header.php: Custom_Image_Header::step_2()	Display second step of custom header image page.
wp-admin/custom-header.php: Custom_Image_Header::step_3()	Display third step of custom header image page.
wp-admin/includes/ajax-actions.php: wp_ajax_crop_image()	Ajax handler for cropping an image.

Changelog

Changelog
Version	Description
WP-2.1.0	Introduced.