function trigger_example_help in Examples for Developers 6

Same name and namespace in other branches

1. 7 trigger_example/trigger_example.module \trigger_example_help()

Implementation of hook_help().

Related topics

File

trigger_example/trigger_example.module, line 16

Code

function trigger_example_help($path, $arg) {
  switch ($path) {
    case 'trigger_example':
      return '<p>' . t('Use this page to call hook_trigger_example() with the ping and pong operations. You can create actions to display a message or email the user on the <a href="@actions-url">Actions settings page</a> and assign these actions with the ping and pong events on the <a href="@triggers-url">Triggers settings page</a>.', array(
        '@actions-url' => url('admin/settings/actions'),
        '@triggers-url' => url('admin/build/trigger/trigger_example'),
      )) . '</p>';
    case 'admin/build/trigger/trigger_example':
      $explanation = '<p>' . t('Triggers are system events, such as when new content is added or when a user logs in. Trigger module combines these triggers with actions (functional tasks), such as unpublishing content or e-mailing an administrator. The <a href="@url">Actions settings page</a> contains a list of existing actions and provides the ability to create and configure additional actions.', array(
        '@url' => url('admin/settings/actions'),
      )) . '</p>';
      return $explanation . '<p>' . t('Below you can assign actions to run when certain comment-related triggers happen. For example, you could promote a post to the front page when a comment is added.') . '</p>';
  }
}