W3cubDocs

/WordPress

load_image_to_edit( string $attachment_id, string $mime_type, string $size = 'full' )

Load an image resource for editing.

Parameters

$attachment_id

(string) (Required) Attachment ID.

$mime_type

(string) (Required) Image mime type.

$size

(string) (Optional) Image size, defaults to 'full'.

Default value: 'full'

Return

(resource|false) The resulting image resource on success, false on failure.

Source

File: wp-admin/includes/image.php 

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;
}

Uses

Uses Description
wp-admin/includes/image.php: _load_image_to_edit_path()

Retrieve the path or url of an attachment’s attached file.
wp-admin/includes/image.php: load_image_to_edit

Filters the current image being loaded for editing.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.

Changelog

Version Description
2.9.0 Introduced.

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