hook_hook_info

hooks/core.php, line 292

Versions

hooks

hook_hook_info()

Expone una lista de disparadores (eventos) al que su módulo le permite a los usuarios asignar acciones.

Este hook es utilizado por el API de Triggers para presentar información acerca de los disparadores (o eventos) al que su módulo le permite a los usuarios asignar acciones.

Ver también hook_action_info().

Por ejemplo, la implementación node_hook_info tiene a 'node' como la clave de más afuera pues es el módulo en donde se encuentra. Después, posee 'nodeapi', como la siguiente clave, pues es hook_nodeapi() la que aplica cambios en los nodos. Finalmente las claves restantes son las distintas operaciones para hook_nodeapi() que el módulo node está exponiendo como disparadores.

Valor de retorno

• Un array anidado. La clave de más afuera define el módulo al que pertenecen los disparadores. El sistema de menú utilizará esta clave para ver en el archivo .info del módulo y hacer una tarea local (una pestaña) dentro de la interfaz del módulo trigger.
  • La siguiente clave define el hook que esta siendo definido.
    • Dentro de ese array, se encuentra una lista de arrays identificados por operaciones de hook.
      • Cada uno de esos arrays poseen una clave llamada 'runs when' (ejecutado cuando) y un valor que es una descripción en Inglés del hook.

Código

<?php
function hook_hook_info() {
  return array(
    'node' => array(
      'nodeapi' => array(
        'presave' => array(
          'runs when' => t('When either saving a new post or updating an existing post'),
        ),
        'insert' => array(
          'runs when' => t('After saving a new post'),
        ),
        'update' => array(
          'runs when' => t('After saving an updated post'),
        ),
        'delete' => array(
          'runs when' => t('After deleting a post')
        ),
        'view' => array(
          'runs when' => t('When content is viewed by an authenticated user')
        ),
      ),
    ),
  );
}
?>