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

wp_load_image( string $file )

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

Description Description

Parameters Parameters


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

Top ↑

Return Return

(resource) The resulting image resource on success, Error string on failure.

Top ↑

Source 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 ) )
		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_resource( $image ) )
		return sprintf(__('File “%s” is not an image.'), $file);

	return $image;

Top ↑

Changelog Changelog

Version Description
3.5.0 Use wp_get_image_editor()
2.1.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.