image_get_info

Versions
4.6 – 6: image_get_info($file)
7: image_get_info($filepath, $toolkit = FALSE)

Get details about an image.

Drupal supports GIF, JPG and PNG file formats when used with the GD toolkit, and may support others, depending on which toolkits are installed.

Parameters

$filepath String specifying the path of the image file.

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

Return value

FALSE, if the file could not be found or is not an image. Otherwise, a keyed array containing information about the image:

"width": Width, in pixels.
"height": Height, in pixels.
"extension": Commonly used file extension for the image.
"mime_type": MIME type ('image/jpeg', 'image/gif', 'image/png').
"file_size": File size in bytes.

▸ 9 functions call image_get_info()

▾ 9 functions call image_get_info()

file_validate_image_resolution in includes/file.inc: If the file is an image verify that its dimensions are within the specified maximum and minimum dimensions.
file_validate_is_image in includes/file.inc: Check that the file is recognized by image_get_info() as an image.
hook_prepare in modules/node/node.api.php: Act on a node object about to be shown on the add/edit form.
image_file_download in modules/image/image.module: Implement hook_file_download().
image_load in includes/image.inc: Load an image file and return an image object.
image_save in includes/image.inc: Close the image and save the changes to a file.
theme_image_style_preview in modules/image/image.admin.inc: Theme callback for displaying a preview of an image style.
user_file_download in modules/user/user.module: Implement hook_file_download().
user_save in modules/user/user.module: Save changes to a user account or add a new user.

Code

includes/image.inc, line 120

<?php
function image_get_info($filepath, $toolkit = FALSE) {
  $details = FALSE;
  if (!is_file($filepath)) {
    return $details;
  }

  if (!$toolkit) {
    $toolkit = image_get_toolkit();
  }
  if ($toolkit) {
    $image = new stdClass();
    $image->source = $filepath;
    $image->toolkit = $toolkit;
    $details = image_toolkit_invoke('get_info', $image);
    if (isset($details) && is_array($details)) {
      $details['file_size'] = filesize($filepath);
    }
  }

  return $details;
}
?>