A WordPress-centric search engine for devs and theme authors



load_image_to_edit ›

Since2.9.0
Deprecatedn/a
load_image_to_edit ( $attachment_id, $mime_type, $size = 'full' )
Parameters: (3)
  • (string) $attachment_id Attachment ID.
    Required: Yes
  • (string) $mime_type Image mime type.
    Required: Yes
  • (string) $size Optional. Image size, defaults to 'full'.
    Required: No
    Default: 'full'
Returns:
  • (resource|false) The resulting image resource on success, false on failure.
Defined at:
Codex:

Load an image resource for editing.



Source

function load_image_to_edit( $attachment_id, $mime_type, $size = 'full' ) {
	$filepath = _load_image_to_edit_path( $attachment_id, $size );
	if ( empty( $filepath ) ) {
		return false;
	}

	switch ( $mime_type ) {
		case 'image/jpeg':
			$image = imagecreatefromjpeg( $filepath );
			break;
		case 'image/png':
			$image = imagecreatefrompng( $filepath );
			break;
		case 'image/gif':
			$image = imagecreatefromgif( $filepath );
			break;
		default:
			$image = false;
			break;
	}
	if ( is_resource( $image ) ) {
		/**
		 * Filters the current image being loaded for editing.
		 *
		 * @since 2.9.0
		 *
		 * @param resource $image         Current image.
		 * @param string   $attachment_id Attachment ID.
		 * @param string   $size          Image size.
		 */
		$image = apply_filters( 'load_image_to_edit', $image, $attachment_id, $size );
		if ( function_exists( 'imagealphablending' ) && function_exists( 'imagesavealpha' ) ) {
			imagealphablending( $image, false );
			imagesavealpha( $image, true );
		}
	}
	return $image;
}