function site_alert_help in Site Alert 8

Implements hook_help().

File

./site_alert.module, line 27

Allows admins to display a site-wide alert to all users.

Code

function site_alert_help($route_name, RouteMatchInterface $route_match) {
  $output = '';
  switch ($route_name) {
    case 'help.page.site_alert':
      $output .= '<p>';
      $output .= 'Site alert allows a privileged user to display an alert';
      $output .= ' across the top of every page to every user. Site alerts can';
      $output .= ' be scheduled to turn on a specific date and time as well as';
      $output .= ' expire on a specific date and time. ';
      $output .= '</p>';
      $output .= '<p>';
      $output .= 'Users must select a "severity" when managing site alerts.';
      $output .= ' This indicates to the theme how the alert should look. For';
      $output .= ' example, a high severity message may be styled in red or';
      $output .= ' may have a specific animation to ensure users see it.';
      $output .= '</p>';
      break;
  }
  return $output;
}