wpseek.com
A WordPress-centric search engine for devs and theme authors



wp_crop_image › WordPress Function

Since2.1.0
Deprecatedn/a
› wp_crop_image ( $src, $src_x, $src_y, $src_w, $src_h, $dst_w, $dst_h, $src_abs = false, $dst_file = false )
Parameters: (9)
  • (string|int) $src The source file or Attachment ID.
    Required: Yes
  • (int) $src_x The start x position to crop from.
    Required: Yes
  • (int) $src_y The start y position to crop from.
    Required: Yes
  • (int) $src_w The width to crop.
    Required: Yes
  • (int) $src_h The height to crop.
    Required: Yes
  • (int) $dst_w The destination width.
    Required: Yes
  • (int) $dst_h The destination height.
    Required: Yes
  • (bool|false) $src_abs Optional. If the source crop points are absolute.
    Required: No
    Default: false
  • (string|false) $dst_file Optional. The destination file to write to.
    Required: No
    Default: false
Returns:
  • (string|WP_Error) New filepath on success, WP_Error on failure.
Defined at:
Codex:

Crops an image to a given size.



Related Functions: wp_ajax_crop_image, wp_load_image, wp_restore_image, wp_stream_image, wp_save_image

Source 

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( wp_basename( $src_file ), 'cropped-' . wp_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 ), wp_basename( $dst_file ) );

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

	if ( ! empty( $result['path'] ) ) {
		return $result['path'];
	}

	return $dst_file;
}