function role_watchdog_help in Role Watchdog 8

Same name and namespace in other branches

1. 5 role_watchdog.module \role_watchdog_help()
2. 6.2 role_watchdog.module \role_watchdog_help()
3. 6 role_watchdog.module \role_watchdog_help()
4. 7.2 role_watchdog.module \role_watchdog_help()
5. 7 role_watchdog.module \role_watchdog_help()

Implements hook_help().

File

./role_watchdog.module, line 15

Contains role_watchdog.module.

Code

function role_watchdog_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {

    // Main module help for the role_watchdog module.
    case 'help.page.role_watchdog':
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('Role watchdog will automatically start recording all role changes. No further configuration is necessary for this functionality, the module will do this "out of the box". A record of these changes is shown in a Role history tabs on each user\'s page.') . '</p>' . '<p>' . t('Role watchdog can optionally email members of selected Notify roles when selected Monitor roles are added or removed. This was specifically added to keep a closer eye on certain role changes, such as an Administrator role. At least one Monitor role and one Notify role must be selected for this functionality.') . '</p>';
      return $output;
    default:
  }
}