Function __global->cns_join_form

Definitions

sources/cns_join.php

  • Get the join form.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$url Tempcode No No required parameter N/A N/A URL to direct to
$captcha_if_enabled boolean No No True N/A N/A Whether to handle CAPTCHA (if enabled at all)
$intro_message_if_enabled boolean No No True N/A N/A Whether to ask for intro messages (if enabled at all)
$invites_if_enabled boolean No No True N/A N/A Whether to check for invites (if enabled at all)
$adjusted_config_options array No No [] N/A N/A A map of adjusted config options

Returns

  • The form
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the join form.
 *
 * @param  Tempcode $url URL to direct to
 * @param  boolean $captcha_if_enabled Whether to handle CAPTCHA (if enabled at all)
 * @param  boolean $intro_message_if_enabled Whether to ask for intro messages (if enabled at all)
 * @param  boolean $invites_if_enabled Whether to check for invites (if enabled at all)
 * @param  array $adjusted_config_options A map of adjusted config options
 * @return Tempcode The form
 */
function cns_join_form(object $url, bool $captcha_if_enabled = true, bool $intro_message_if_enabled = true, bool $invites_if_enabled = true, array $adjusted_config_options = []) : object