function require_login_help in Require Login 8.2

Same name and namespace in other branches

1. 8 require_login.module \require_login_help()

Implements hook_help().

File

./require_login.module, line 13

Hook implementations for the require_login module.

Code

function require_login_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {
    case 'help.page.require_login':
      $output = '<p>' . t('Provides catch-all solution to require user authentication on pages.') . '</p>';
      $output .= '<h3>' . t('Features') . '</h3>';
      $output .= '<dl>';
      $output .= '  <dt>' . t('Enforce user authentication for any or all pages.') . '</dt>';
      $output .= '  <dt>' . t('Change the default user login path (/user/login).') . '</dt>';
      $output .= '  <dt>' . t('Exclude content types, paths, or router names as needed.') . '</dt>';
      $output .= '  <dt>' . t('Configure access to 403 (access denied) and (404) not found pages.') . '</dt>';
      $output .= '  <dt>' . t('Translatable access denied message seen by anonymous users.') . '</dt>';
      $output .= '  <dt>' . t('Fully translatable configuration for per-language exclusions.') . '</dt>';
      $output .= '</dl>';
      $output .= '<h3>' . t('Usage') . '</h3>';
      $output .= '<dl>';
      $output .= '  <dt>' . t('Install the module.') . '</dt>';
      $output .= '  <dt>' . t('Set permissions: /admin/people/permissions#module-require_login') . '</dt>';
      $output .= '  <dt>' . t('Configure settings: /admin/config/people/require-login') . '</dt>';
      $output .= '</dl>';
      return $output;
  }
  return NULL;
}