You are here

Home » API reference » Drupal 7 » image.module

function image_effect_load in Drupal 7

Loads a single image effect.

Parameters

$ieid: The image effect ID.

$style_name: The image style name.

$include: If set, this loader will restrict to a specific type of image style, may be one of the defined Image style storage constants.

Return value

An image effect array, consisting of the following keys:

  • "ieid": The unique image effect ID.
  • "isid": The unique image style ID that contains this image effect.
  • "weight": The weight of this image effect within the image style.
  • "name": The name of the effect definition that powers this image effect.
  • "data": An array of configuration options for this image effect.

Besides these keys, the entirety of the image definition is merged into the image effect array. Returns FALSE if the specified effect cannot be found.

See also

image_style_load()

image_effect_definition_load()

1 call to image_effect_load()
image_help in modules/image/image.module
Implements hook_help().

File

modules/image/image.module, line 1288
Exposes global functionality for creating image styles.

Code

function image_effect_load($ieid, $style_name, $include = NULL) {
  if (($style = image_style_load($style_name, NULL, $include)) && isset($style['effects'][$ieid])) {
    return $style['effects'][$ieid];
  }
  return FALSE;
}