actions_list

• Drupal 6
• Drupal 7

• View documentation
• List references

Definition

actions_list($reset = FALSE)
includes/actions.inc, line 151

Description

Discover all action functions by invoking hook_action_info().

mymodule_action_info() { return array( 'mymodule_functiondescription_action' => array( 'type' => 'node', 'description' => t('Save node'), 'configurable' => FALSE, 'hooks' => array( 'nodeapi' => array('delete', 'insert', 'update', 'view'), 'comment' => array('delete', 'insert', 'update', 'view'), ) ) ); }

The description is used in presenting possible actions to the user for configuration. The type is used to present these actions in a logical grouping and to denote context. Some types are 'node', 'user', 'comment', and 'system'. If an action is configurable it will provide form, validation and submission functions. The hooks the action supports are declared in the 'hooks' array.

<?php

$actions['node_publish_action'] = array(
'type' => 'node',
'description' => t('Publish post'),
'configurable' => FALSE,
'hooks' => array(
'nodeapi' => array('presave', 'insert', 'update', 'view'),
'comment' => array('delete', 'insert', 'update', 'view'),
),
);

?>

Parameters

$reset Reset the action info static cache.

Return value

An associative array keyed on function name. The value of each key is an array containing information about the action, such as type of action and description of the action, e.g.,

Code

<?php
function actions_list($reset = FALSE) {
  static $actions;
  if (!isset($actions) || $reset) {
    $actions = module_invoke_all('action_info');
    drupal_alter('action_info', $actions);
  }

  // See module_implements for explanations of this cast.
  return (array)$actions;
}
?>