You are here

function regcode_help in Registration codes 5.3

Same name and namespace in other branches
  1. 8 regcode.module \regcode_help()
  2. 5 regcode.module \regcode_help()
  3. 6.2 regcode.module \regcode_help()
  4. 6 regcode.module \regcode_help()
  5. 7.2 regcode.module \regcode_help()
  6. 7 regcode.module \regcode_help()

Display help and module information.

Parameters

section: The section of the site where we're displaying help.

Return value

The help text for the section.

File

./regcode.module, line 38
The main module file of the registration code module

Code

function regcode_help($section) {
  switch ($section) {
    case 'admin/help#regcode':
      return t('
                <p>Allows administrators to set a registration code or codes that new users
                must enter before they can complete the registration process. If a new user
                enters a code that is not in the list of valid codes, he or she is denied
                registration.</p>

                <p>To set the codes, go to Administer->Site configuration->Registration code
                and enter them there. To disable the registration code requirement for new
                users, simply disable the module (in Administer->Site building->Modules).</p>
              ');
  }
}