function hook_trigger_info

You are here

7 trigger.api.php hook_trigger_info()

Declare triggers (events) for users to assign actions to.

This hook is used by the trigger module to create a list of triggers (events) that users can assign actions to. Your module is responsible for detecting that the events have occurred, calling trigger_get_assigned_actions() to find out which actions the user has associated with your trigger, and then calling actions_do() to fire off the actions.

Return value

A nested associative array.

  • The outermost key is the name of the module that is defining the triggers. This will be used to create a local task (tab) in the trigger module's user interface. A contrib module may supply a trigger for a core module by giving the core module's name as the key. For example, you could use the 'node' key to add a node-related trigger.

    • Within each module, each individual trigger is keyed by a hook name describing the particular trigger (this is not visible to the user, but can be used by your module for identification).

      • Each trigger is described by an associative array. Currently, the only key-value pair is 'label', which contains a translated human-readable description of the triggering event.

For example, the trigger set for the 'node' module has 'node' as the outermost key and defines triggers for 'node_insert', 'node_update', 'node_delete' etc. that fire when a node is saved, updated, etc.

See also

hook_action_info()

hook_trigger_info_alter()

Related topics

3 functions implement hook_trigger_info()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

actions_loop_test_trigger_info in modules/simpletest/tests/actions_loop_test.module
Implements hook_trigger_info().
trigger_test_trigger_info in modules/trigger/tests/trigger_test.module
Implements hook_trigger_info().
trigger_trigger_info in modules/trigger/trigger.module
Implements hook_trigger_info().
2 invocations of hook_trigger_info()
trigger_assign in modules/trigger/trigger.admin.inc
Builds a form that allows users to assign actions to triggers.
_trigger_get_all_info in modules/trigger/trigger.module
Retrieves and caches information from hook_trigger_info() implementations.

File

modules/trigger/trigger.api.php, line 42
Hooks provided by the Trigger module.

Code

function hook_trigger_info() {
  return array(
    'node' => array(
      'node_presave' => array(
        'label' => t('When either saving new content or updating existing content'),
      ),
      'node_insert' => array(
        'label' => t('After saving new content'),
      ),
      'node_update' => array(
        'label' => t('After saving updated content'),
      ),
      'node_delete' => array(
        'label' => t('After deleting content'),
      ),
      'node_view' => array(
        'label' => t('When content is viewed by an authenticated user'),
      ),
    ),
  );
}