wp_load_image( string $file )

This function has been deprecated. Use wp_get_image_editor() instead.

Load an image from a string, if PHP supports it.

Description

See also

Parameters

$file

(string) (Required) Filename of the image to load.

Return

(resource|GdImage|string) The resulting image resource or GdImage instance on success, error string on failure.

Source

File: wp-includes/deprecated.php 

function wp_load_image( $file ) {
	_deprecated_function( __FUNCTION__, '3.5.0', 'wp_get_image_editor()' );

	if ( is_numeric( $file ) )
		$file = get_attached_file( $file );

	if ( ! is_file( $file ) ) {
		/* translators: %s: File name. */
		return sprintf( __( 'File “%s” doesn’t exist?' ), $file );
	}

	if ( ! function_exists('imagecreatefromstring') )
		return __('The GD image library is not installed.');

	// Set artificially high because GD uses uncompressed images in memory.
	wp_raise_memory_limit( 'image' );

	$image = imagecreatefromstring( file_get_contents( $file ) );

	if ( ! is_gd_image( $image ) ) {
		/* translators: %s: File name. */
		return sprintf( __( 'File “%s” is not an image.' ), $file );
	}

	return $image;
}

Uses

Uses Description
wp-includes/media.php: is_gd_image()

Determines whether the value is an acceptable type for GD image functions.
wp-includes/functions.php: wp_raise_memory_limit()

Attempts to raise the PHP memory limit for memory intensive processes.
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/functions.php: _deprecated_function()

Mark a function as deprecated and inform when it has been used.
wp-includes/post.php: get_attached_file()

Retrieve attached file path based on attachment ID.

Changelog

Version Description
3.5.0 Use wp_get_image_editor()
2.1.0 Introduced.

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