1 system.api.php hook_image_toolkits()

Define image toolkits provided by this module.

The file which includes each toolkit's functions must be included in this hook.

The toolkit's functions must be named image_toolkitname_operation(). where the operation may be:

Return value

An array with the toolkit name as keys and sub-arrays with these keys:

  • 'title': A string with the toolkit's title.
  • 'available': A Boolean value to indicate that the toolkit is operating properly, e.g. all required libraries exist.

See also

system_image_toolkits()

Related topics

File

core/modules/system/system.api.php, line 1408
Hooks provided by Backdrop core and the System module.

Code

function hook_image_toolkits() {
  return array(
    'working' => array(
      'title' => t('A toolkit that works.'),
      'available' => TRUE,
    ),
    'broken' => array(
      'title' => t('A toolkit that is "broken" and will not be listed.'),
      'available' => FALSE,
    ),
  );
}