You are here

function imageapi_optimize_processor_load in Image Optimize (or ImageAPI Optimize) 7.2

Loads a single image processor.

Parameters

$ieid: The image processor ID.

$pipeline_name: The image pipeline name.

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

Return value

An image processor array, consisting of the following keys:

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

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

See also

image_pipeline_load()

image_processor_definition_load()

1 call to imageapi_optimize_processor_load()
imageapi_optimize_help in ./imageapi_optimize.module
Implements hook_help().

File

./imageapi_optimize.module, line 664

Code

function imageapi_optimize_processor_load($ieid, $pipeline_name, $include = NULL) {
  if (($pipeline = imageapi_optimize_pipeline_load($pipeline_name, NULL, $include)) && isset($pipeline['processors'][$ieid])) {
    return $pipeline['processors'][$ieid];
  }
  return FALSE;
}