function user_default_page_help in User Default Page 8.2

Same name and namespace in other branches

1. 8 user_default_page.module \user_default_page_help()

Implements hook_help().

File

./user_default_page.module, line 14

Contains user_default_page.module..

Code

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

    // Main module help for the user_default_page module.
    case 'help.page.user_default_page':
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('The module allows you to customize the destination that a user is redirected to after logging in or logged out. You can customize by roles or individual users. And customize configurable drupal messages for this actions. Do read README.txt file for more information.') . '</p>';
      $output .= '<h3>' . t('Installation') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Enable the module via <a href=":drush_install_module">drush command</a> or the <a href=":extend_link">extend menu</a>.', [
        ':extend_link' => '/admin/modules',
        ':drush_install_module' => 'https://www.drupal.org/docs/8/extending-drupal-8/installing-modules-from-the-command-line',
      ]) . '</dt>';
      $output .= '</dl>';
      $output .= '<h3>' . t('Usage') . '</h3>';
      $output .= '<ul>';
      $output .= '<li>' . t('Go to the <a href=":config_page">configuration page</a>.', [
        ':config_page' => '/admin/config/user_default_page_config_entity/',
      ]) . '</li>';
      $output .= '<li>' . t('Add default pages by clicking on <strong>Add User default page</strong> button or the operation link on each created default page.') . '</li>';
      $output .= '<ul>';
      $output .= '<li>' . t('Define the page label (just to be easy to identify).') . '</li>';
      $output .= '<li>' . t('Select the role, the user or both that will use this default page.') . '</li>';
      $output .= '<li>' . t('If you are setting a login page, insert the redirect using internal URL (eg.: /node/5). Also, you can insert a message that will be displayed after the redirect.') . '</li>';
      $output .= '<li>' . t('In case of a logout, the configuration is basically the same of the login.') . '</li>';
      $output .= '<li>' . t('You can use just login redirect, just logout redirect or both.') . '</li>';
      $output .= '</ul>';
      $output .= '</li>';
      $output .= '</ul>';
      return $output;
  }
}