Home › API reference › image.inc

image_get_info

  1. drupal
    1. 4.7 image.inc
    2. 5 image.inc
    3. 6
    4. 7
Versions
4.7 – 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.

Related topics

Image toolkits
Functions for image file manipulations.

▸ 9 functions call image_get_info()

▾ 9 functions call image_get_info()

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

Code

drupal/includes/image.inc, line 125

<?php
function image_get_info($filepath, $toolkit = FALSE) {
  $details = FALSE;
  if (!is_file($filepath) && !is_uploaded_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;
}
?>