function site_status_message_help in Site Status Message 8

Same name and namespace in other branches

1. 7 site_status_message.module \site_status_message_help()

Implements hook_help().

File

./site_status_message.module, line 20

Site Status Message provides a configurable page top message.

Code

function site_status_message_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {
    case 'help.page.site_status_message':
      $output = '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('The Site Status Message is a simple module to display a site wide message to your users at the top of each page. Use cases could be to inform of known downtime in the future, to advertise a special offer on the site or some important news that needs highlighting.') . '</p>';
      $output .= '<p>' . t('An optional link to a page with more information can be displayed after the message.') . '</p>';
      $output .= '<p>' . t('The settings for this module can be configured on the <a href="@url">Site Information</a> page.', [
        '@url' => '/admin/config/system/site-information#edit-site-status',
      ]) . '</p>';
      return $output;
  }
}