imagemagick.api.php in ImageMagick 7

API documentation for the ImageMagick module.

File

imagemagick.api.php

<?php

/**
 * @file
 * API documentation for the ImageMagick module.
 */

/**
 * @addtogroup hooks
 * @{
 */

/**
 * Alter an image as it is loaded by the ImageMagick toolkit.
 *
 * @param $image
 *   An image object.
 *
 * @see image_load()
 * @see image_imagemagick_load()
 */
function hook_imagemagick_load_alter(stdClass $image) {
}

/**
 * Alter an image before it is saved by the ImageMagick toolkit.
 *
 * @param $image
 *   An image object.
 * @param $context
 *   An associative array of information about the image being saved:
 *   - destination: The file URI where $image will be saved to.
 *
 * @see image_save()
 * @see image_imagemagick_save()
 */
function hook_imagemagick_save_alter(stdClass $image, $context = array()) {
}

/**
 * Alter the arguments to the ImageMagick 'convert' command-line program.
 *
 * @param $args
 *   An array of arguments to the ImageMagick 'convert' command-line program.
 * @param $context
 *   An associative array of information about the image being altered:
 *   - source: The filesystem path of the original image.
 *   - source_original: The original file URI of the image.
 *   - destination: The filesystem path for the derivative image.
 *   - destination_original: The original file URI for the derivative image.
 *   - destination_format: The target image format for the derivative image.
 *     Defaults to an empty string.
 *
 * ImageMagick automatically converts the target image to the format denoted by
 * the file extension. However, since changing the file extension is not always
 * an option (e.g., for derivative images of core Image module styles), you can
 * specify an alternative derivative image format in
 * $context['destination_format']. 'destination_format' is a string denoting a
 * file extension. If not empty, it is passed to ImageMagick's convert binary in
 * the syntax "[destination_format]:[destination]".
 *
 * @see http://www.imagemagick.org/script/command-line-processing.php#output
 * @see http://www.imagemagick.org/Usage/files/#save
 *
 * @see _imagemagick_convert()
 */
function hook_imagemagick_arguments_alter($args, $context = array()) {
}

Functions

Name	Description
hook_imagemagick_arguments_alter	Alter the arguments to the ImageMagick 'convert' command-line program.
hook_imagemagick_load_alter	Alter an image as it is loaded by the ImageMagick toolkit.
hook_imagemagick_save_alter	Alter an image before it is saved by the ImageMagick toolkit.