Function __global->cns_join_actual

Definitions

sources/cns_join.php

  • Actualise the join form.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$declarations_made LONG_TEXT No No Blank (empty string) N/A N/A A list of declarations to which the member agreed separated by a newline (blank: member did not agree to any declarations yet)
$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)
$instant_login boolean No No True N/A N/A Whether to instantly log the user in
$username ?ID_TEXT No No Null N/A N/A Username (null: read from environment)
$email_address ?EMAIL No No Null N/A N/A E-mail address (null: read from environment)
$password ?string No No Null N/A N/A Password (null: read from environment)
$actual_custom_fields ?array No No Null N/A N/A Custom fields to save (null: read from environment)
$adjusted_config_options array No No [] N/A N/A A map of adjusted config options

Returns

  • A tuple: Messages to show, member ID of new member, whether the account is ready
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Actualise the join form.
 *
 * @param  LONG_TEXT $declarations_made A list of declarations to which the member agreed separated by a newline (blank: member did not agree to any declarations yet)
 * @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  boolean $instant_login Whether to instantly log the user in
 * @param  ?ID_TEXT $username Username (null: read from environment)
 * @param  ?EMAIL $email_address E-mail address (null: read from environment)
 * @param  ?string $password Password (null: read from environment)
 * @param  ?array $actual_custom_fields Custom fields to save (null: read from environment)
 * @param  array $adjusted_config_options A map of adjusted config options
 * @return array A tuple: Messages to show, member ID of new member, whether the account is ready
 */
function cns_join_actual(string $declarations_made = '', bool $captcha_if_enabled = true, bool $intro_message_if_enabled = true, bool $invites_if_enabled = true, bool $instant_login = true, ?string $username = null, ?string $email_address = null, ?string $password = null, ?array $actual_custom_fields = null, array $adjusted_config_options = []) : array