1. 8.5.x core/lib/Drupal/Core/ImageToolkit/ImageToolkitInterface.php image
  2. 8.0.x core/lib/Drupal/Core/ImageToolkit/ImageToolkitInterface.php image
  3. 8.1.x core/lib/Drupal/Core/ImageToolkit/ImageToolkitInterface.php image
  4. 8.2.x core/lib/Drupal/Core/ImageToolkit/ImageToolkitInterface.php image
  5. 8.3.x core/lib/Drupal/Core/ImageToolkit/ImageToolkitInterface.php image
  6. 8.4.x core/lib/Drupal/Core/ImageToolkit/ImageToolkitInterface.php image
  7. 8.6.x core/lib/Drupal/Core/ImageToolkit/ImageToolkitInterface.php image
  8. 6.x includes/image.inc image
  9. 7.x includes/image.inc image

Drupal's image toolkits provide an abstraction layer for common image file manipulations like scaling, cropping, and rotating. The abstraction frees module authors from the need to support multiple image libraries, and it allows site administrators to choose the library that's best for them.

PHP includes the GD library by default so a GD toolkit is installed with Drupal. Other toolkits like ImageMagic are available from contrib modules. GD works well for small images, but using it with larger files may cause PHP to run out of memory. In contrast the ImageMagick library does not suffer from this problem, but it requires the ISP to have installed additional software.

Image toolkits are installed by copying the image.ToolkitName.inc file into Drupal's includes directory. The toolkit must then be enabled using the admin/settings/image-toolkit form.

Only one toolkit maybe selected at a time. If a module author wishes to call a specific toolkit they can check that it is installed by calling image_get_available_toolkits(), and then calling its functions directly.


includes/image.inc, line 8
API for manipulating images.


Namesort descending Location Description
image_crop includes/image.inc Crop an image to the rectangle specified by the given rectangle.
image_gd_check_settings includes/image.gd.inc Verify GD2 settings (that the right version is actually installed).
image_gd_close includes/image.gd.inc GD helper to write an image resource to a destination file.
image_gd_crop includes/image.gd.inc Crop an image using the GD toolkit.
image_gd_info includes/image.gd.inc Retrieve information about the toolkit.
image_gd_open includes/image.gd.inc GD helper function to create an image resource from a file.
image_gd_resize includes/image.gd.inc Scale an image to the specified size using GD.
image_gd_rotate includes/image.gd.inc Rotate an image the given number of degrees.
image_gd_settings includes/image.gd.inc Retrieve settings for the GD2 toolkit.
image_gd_settings_validate includes/image.gd.inc Validate the submitted GD settings.
image_get_available_toolkits includes/image.inc Return a list of available toolkits.
image_get_info includes/image.inc Get details about an image.
image_get_toolkit includes/image.inc Retrieve the name of the currently used toolkit.
image_resize includes/image.inc Resize an image to the given dimensions (ignoring aspect ratio).
image_rotate includes/image.inc Rotate an image by the given number of degrees.
image_scale includes/image.inc Scales an image to the given width and height while maintaining aspect ratio.
image_scale_and_crop includes/image.inc Scales an image to the exact width and height given. Achieves the target aspect ratio by cropping the original image equally on both sides, or equally on the top and bottom. This function is, for example, useful to create uniform sized avatars from…
image_toolkit_invoke includes/image.inc Invokes the given method using the currently selected toolkit.