A WordPress-centric search engine for devs and theme authors



wp_load_image ›

Since2.1.0
Deprecated3.5.0
wp_load_image ( $file )
Parameters:
  • (string) $file Filename of the image to load.
    Required: Yes
See:
Returns:
  • (resource) The resulting image resource on success, Error string on failure.
Defined at:
Codex:

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



Source

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_resource( $image ) ) {
		/* translators: %s: file name */
		return sprintf( __( 'File “%s” is not an image.' ), $file );
	}

	return $image;
}