function user_email_verification_help in User email verification 8

Implements hook_help().

File

./user_email_verification.module, line 314

User email verification hooks and alters.

Code

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

    // Main module help for the user_email_verification module.
    case 'help.page.user_email_verification':
      $output = '<h3>' . t('About') . '</h3>';
      $output .= '<strong>' . t('Module allows:') . '</strong>';
      $output .= '<ul>';
      $output .= '<li>' . t('to have Email verification') . '</li>';
      $output .= '<li>' . t('to type password on registration') . '</li>';
      $output .= '<li>' . t('to be logged in right after registration') . '</li>';
      $output .= '</ul>';
      $output .= '<p>' . t('If user do not verify the Email in a certain time interval account will be blocked.');
      $output .= '<h3>' . t('Configuration:') . '</h3>';
      $output .= '<ul>';
      $output .= '<li>' . t('Go to: Manage -> Configuration -> Account settings') . '</li>';
      $output .= '<li>' . t('In <strong>Registration and cancellation</strong> section:');
      $output .= '<ul>';
      $output .= '<li>' . t('Set "Visitors" option for "Who can register accounts?"') . '</li>';
      $output .= '<li>' . t('Uncheck "Require email verification when a visitor creates an account"') . '</li>';
      $output .= '</ul></li>';
      $output .= '<li>' . t('In <strong>Emails</strong> section:');
      $output .= '<ul>';
      $output .= '<li>' . t('Add [user:verify-email] to the "Welcome (no approval required)" mail to send to the user the Email verification link') . '</li>';
      $output .= '</ul></li>';
      $output .= '<li>' . t('In User Email verification section:');
      $output .= '<ul>';
      $output .= '<li>' . t('Set "Skip roles" - the roles which shouldn\'t verify the Email') . '</li>';
      $output .= '<li>' . t('Set "Verification time interval" (in seconds) - the time for user to verify the Email, <strong>when this time is over - user account will be blocked</strong>') . '</li>';
      $output .= '<li>' . t('Set "Send reminder" - how many times user will be notified (with Verification mail) during "Verification time interval"');
      $output .= '<ul>';
      $output .= '<li>' . t('Customize "Verification mail subject" and "Verification mail body" if "Send reminder" was set') . '</li>';
      $output .= '</ul></li>';
      $output .= '<li>' . t('Check "Enable extended verification period" if you\'d like to provide an extra time to the user to verify the Email and activate blocked account');
      $output .= '<ul>';
      $output .= '<li>' . t('Set "Extended verification time interval" (in seconds) - the time for user to verify Email and unblock account, <strong>when this time is over - user account will be removed or blocked, depends on "When cancelling a user account" setting</strong>') . '</li>';
      $output .= '<li>' . t('Customize "Mail subject" and "Mail body"') . '</li>';
      $output .= '</ul></li>';
      $output .= '</ul></li>';
      $output .= '<li>' . t('Click "Save configuration" button') . '</li>';
      $output .= '</ul>';
      return $output;
    default:
  }
}