Loads an image file and returns 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

6 calls to image_load()

file_validate_image_resolution in includes/file.inc

Verifies that image dimensions are within the specified maximum and minimum.

ImageToolkitGdTestCase::testManipulations in modules/simpletest/tests/image.test

Since PHP can't visually check that our images have been manipulated properly, build a list of expected color values for each of the corners and the expected height and widths for the final images.

ImageToolkitGdTestCase::testTransparentColorOutOfRange in modules/simpletest/tests/image.test

Tests loading an image whose transparent color index is out of range.

ImageToolkitUnitTest::testLoad in modules/simpletest/tests/image.test

Test the image_load() function.

image_style_create_derivative in modules/image/image.module

Creates a new image derivative based on an image style.

... See full list

File

includes/image.inc, line 383

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

---