hook_action_info

developer/hooks/core.php, строка 65

Версии
6: hook_action_info()

Информирует триггеры Друпала о новых действиях.

Любой модуль Друпала может определить любое количество действий (action). Модуль trigger является примером модуля, который использует эти действия. Действие состоит из двух или трех частей:

описания действия (возвращаемое эти хуком);
функции, которая выполняет действие (по соглашению эту функцию называют имя_модуля + '_' + описание_действия + '_action');
необязательного описания формы настроек для этого действия (форму настроек описывает функция с именем полное_имя_действия + '_form').

Функции, которая выполняет действие при вызове передается 2 параметра: объект того же типа, как и значение элемента 'type' из массива hook_action_info, и массив-контекст, описывающий, собственно, контекст, в котором в данный момент запускается действие. К примеру, модуль trigger устанавливает в этом массиве значения с ключами 'hook' и 'op' (то есть для действия, вызываемого при обработке события 'insert' в хуке 'nodeapi' контекст может выглядеть как array('hook' => 'nodeapi', 'op' => 'insert')).

Возвращаемое значение

Ассоциативный массив описаний всех действий, реализованных в модуле. Ключи этого массива — имена функций, реализующих действие, значения — описания действий. Описание действия в свою очередь является ассоциативным массивом с такими парами ключ-значение:
- 'type': (обязательно) определяет, какой тип объектов будет передан действию. Допустимые значения: 'node', 'user', 'comment' и 'system' или любой пользовательский тип. Например, для модуля nodequeue, реализующего последовательность нод, тип можно установить равным 'nodequeue', если действие должно работать с последовательностями нод.
- 'description': (обязательно) Описание действия для пользователей.
- 'configurable': (обязательно) Булево значение. Если оно равно FALSE, действию не требуется дополнительная настройка. Если TRUE — настройка требуется, в этом случае необходимо определить конструктор формы настройки. Конструктор формы настройки — это функция с именем, состоящим из имени действия и суффикса '_form' (т.е., для действия 'node_assign_owner_action' это будет 'node_assign_owner_action_form'). Функции передается параметр $context; при необходимости форму можно дополнить стандартными функциями _submit и _validate.
- 'hooks': (обязательно) Массив всех операций, к которым применимо данное дейстиве. Ключами массива являются имена хуков. Модуль trigger использует этот параметр для того, чтобы отфильтровать непоходящие действия в административном интерфейсе. Определяя в модуле действие, поддерживающее все возможные хуки, можно установить 'hooks' => array('any' => TRUE). Часто используются хуки 'user', 'nodeapi', 'comment' и 'taxonomy'. Можно использовать имя любого хука, определенного с помощью функции hook_hook_info().
- 'behavior': (необязательно) Массив, описывающий «поведение» действия. Ядро Друпала поддерживает только одно поведение — 'changes_node_property'. Если для действия указано такое поведение, это означает, что действие изменяет свойства ноды; в этом случае по окончанию действия нода будет автоматически сохранена.

Declare information about one or more Drupal actions.

Any module can define any number of Drupal actions. The trigger module is an example of a module that uses actions. An action consists of two or three parts: (1) an action definition (returned by this hook), (2) a function which does the action (which by convention is named module + '_' + description of what the function does + '_action'), and an optional form definition function that defines a configuration form (which has the name of the action with '_form' appended to it.)

The function that is called when the action is triggered is passed two parameters - an object of the same type as the 'type' value of the hook_action_info array, and a context variable that contains the context under which the action is currently running, sent as an array. For example, the actions module sets the 'hook' and 'op' keys of the context array (so, 'hook' may be 'nodeapi' and 'op' may be 'insert').

Return value

An array of action descriptions. Each action description is an associative array, where the key of the item is the action's function, and the following key-value pairs:
- 'type': (required) the type is determined by what object the action acts on. Possible choices are node, user, comment, and system. Or whatever your own custom type is. So, for the nodequeue module, the type might be set to 'nodequeue' if the action would be performed on a nodequeue.
- 'description': (required) The human-readable name of the action.
- 'configurable': (required) If FALSE, then the action doesn't require any extra configuration. If TRUE, then you should define a form function with the same name as the key, but with '_form' appended to it (i.e., the form for 'node_assign_owner_action' is 'node_assign_owner_action_form'.) This function will take the $context as the only parameter, and is paired with the usual _submit function, and possibly a _validate function.
- 'hooks': (required) An array of all of the operations this action is appropriate for, keyed by hook name. The trigger module uses this to filter out inappropriate actions when presenting the interface for assigning actions to events. If you are writing actions in your own modules and you simply want to declare support for all possible hooks, you can set 'hooks' => array('any' => TRUE). Common hooks are 'user', 'nodeapi', 'comment', or 'taxonomy'. Any hook that has been described to Drupal in hook_hook_info() will work is a possiblity.
- 'behavior': (optional) Human-readable array of behavior descriptions. The only one we have now is 'changes node property'. You will almost certainly never have to return this in your own implementations of this hook.

Связанные темы

▸ 1 функция вызывает hook_action_info()

▾ 1 функция вызывает hook_action_info()

actions_list in includes/actions.inc: Находит все действия (actions) путем вызова hook_action_info().

Код

<?php
function hook_action_info() {
  return array(
    'comment_unpublish_action' => array(
      'description' => t('Unpublish comment'),
      'type' => 'comment',
      'configurable' => FALSE,
      'hooks' => array(
        'comment' => array('insert', 'update'),
      )
    ),
    'comment_unpublish_by_keyword_action' => array(
      'description' => t('Unpublish comment containing keyword(s)'),
      'type' => 'comment',
      'configurable' => TRUE,
      'hooks' => array(
        'comment' => array('insert', 'update'),
      )
    )
  );
}
?>

Войдите или зарегистрируйтесь, чтобы получить возможность отправлять комментарии

Возвращаемое значение

Return value

Связанные темы

▸ 1 функция вызывает hook_action_info()

▾ 1 функция вызывает hook_action_info()

Код

Вход в систему

Документация