function user_expire_help in User Expire 8

Implements hook_help().

File

./user_expire.module, line 19

Main module file for User expire module.

Code

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

    // Main module help for the user_expire module.
    case 'help.page.user_expire':
      $output = '<h3>' . t('About') . '</h3>';
      $output .= '<dt>' . t('This module allows an administrator to define a date on which to expire a specific user account or to define a period at a role level where inactive accounts will be locked.') . '</dt>';
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dt>' . t('User expire settings.') . '</dt>';
      $output .= '<dd>' . t('This module has a configuration page, see the <a href=":user_expire">User Expire settings</a>.', [
        ':user_expire' => Url::fromRoute('user_expire.admin')
          ->toString(),
      ]) . '</dd>';
      return $output;
      break;
  }
}