image_load

Load an image file and return an image object.

Any changes to the file are not saved until image_save() is called.

Parameters

$file: Path to an image file.

$toolkit: An optional, image toolkit name to override the default.

Return value

An image object or FALSE if there was a problem loading the file. The image object has the following properties:

• 'source' - The original file path.
• 'info' - The array of information returned by image_get_info()
• 'toolkit' - The name of the image toolkit requested when the image was loaded.

Image toolkits may add additional properties. The caller is advised not to monkey about with them.

See also

image_save()

image_get_info()

image_get_available_toolkits()

image_gd_load()

Related topics

Image toolkits

Functions for image file manipulations.

5 calls to image_load()

File

includes/image.inc, line 384

API for manipulating images.

Code

function image_load($file, $toolkit = FALSE) {
  if (!$toolkit) {
    $toolkit = image_get_toolkit();
  }
  if ($toolkit) {
    $image = new stdClass();
    $image->source = $file;
    $image->info = image_get_info($file, $toolkit);
    if (isset($image->info) && is_array($image->info)) {
      $image->toolkit = $toolkit;
      if (image_toolkit_invoke('load', $image)) {
        return $image;
      }
    }
  }
  return FALSE;
}