function image_effect_definition_load

1 image.module image_effect_definition_load($effect)

Load the definition for an image effect.

The effect definition is a set of core properties for an image effect, not containing any user-settings. The definition defines various functions to call when configuring or executing an image effect. This loader is mostly for internal use within image.module. Use image_effect_load() or image_style_load() to get image effects that contain configuration.

Parameters

$effect: The name of the effect definition to load.

Return value

An array containing the image effect definition with the following keys::

"effect": The unique name for the effect being performed. Usually prefixed with the name of the module providing the effect.
"module": The module providing the effect.
"help": A description of the effect.
"function": The name of the function that will execute the effect.
"form": (optional) The name of a function to configure the effect.
"summary": (optional) The name of a theme function that will display a one-line summary of the effect. Does not include the "theme_" prefix.

2 calls to image_effect_definition_load()

image_styles in core/modules/image/image.module: Get an array of all styles and their settings.
image_style_form_add_submit in core/modules/image/image.admin.inc: Submit handler for adding a new image effect to an image style.

File

core/modules/image/image.module, line 1226: Exposes global functionality for creating image styles.

Code

function image_effect_definition_load($effect) {
  $definitions = image_effect_definitions();
  return isset($definitions[$effect]) ? $definitions[$effect] : FALSE;
}