function mass_pwreset_help in Mass Password Reset 8

Same name and namespace in other branches

1. 7 mass_pwreset.module \mass_pwreset_help()
2. 2.x mass_pwreset.module \mass_pwreset_help()

Implements hook_help().

File

./mass_pwreset.module, line 87

Reset user passwords and optionally notify users.

Code

function mass_pwreset_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {
    case 'help.page.mass_pwreset':
      $render['about'] = [
        '#markup' => t('About'),
        '#prefix' => '<h3>',
        '#suffix' => '</h3>',
      ];
      $render['about_content'] = [
        '#markup' => t('This module will reset passwords for specific roles selected. The administrator account (uid 1) can optionally be reset as well.'),
        '#prefix' => '<p>',
        '#suffix' => '</p>',
        'more' => [
          '#markup' => t("There is an option to notify the affected users by using Drupal's password recovery email process."),
          '#prefix' => '<p>',
          '#suffix' => '</p>',
        ],
      ];
      $render['usage'] = [
        '#markup' => t('Usage'),
        '#prefix' => '<h3>',
        '#suffix' => '</h3>',
      ];
      $render['usage_content'] = [
        '#markup' => t('The password reset form is in a tab in the <b>admin people</b> section. Located at <a href="@link">/admin/people/mass-pwreset</a>', [
          '@link' => '/admin/people/mass-pwreset',
        ]),
        '#prefix' => '<p>',
        '#suffix' => '</p>',
        'list' => [
          '#theme' => 'item_list',
          '#title' => t('Password Reset Options'),
          '#items' => [
            'Select either all users (authenicated role) or select specific roles for the users you want to reset',
            'Select to notify active and blocked user accounts using the Drupal password recovery email system',
            'To reset the administrator account (uid 1) you must also select include admin user',
            'Start the process by clicking the "Reset Passwords" button',
          ],
        ],
      ];
      $render['logging'] = [
        '#markup' => t('Logging'),
        '#prefix' => '<h3>',
        '#suffix' => '</h3>',
      ];
      $render['logging_content'] = [
        '#markup' => t('The user accounts will be updated in a batch session. The uid will be logged for each user and the finished batch will be logged as well.'),
        '#prefix' => '<p>',
        '#suffix' => '</p>',
      ];
      return $render;
  }
}