Function __global->add_newsletter_subscriber

Definitions

sources/newsletter2.php

  • Add a newsletter subscriber to the system (not to any particular newsletters though).
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: int

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$email EMAIL No No required parameter N/A N/A The e-mail address of the subscriber
$join_time TIME No No required parameter N/A N/A The join time
$code_confirm integer No No required parameter N/A N/A Confirm code
$password ID_TEXT No No required parameter N/A N/A Newsletter password (hashed)
$salt ID_TEXT No No required parameter N/A N/A Newsletter salt
$language LANGUAGE_NAME No No required parameter N/A N/A The language
$forename string No No required parameter N/A N/A Subscribers forename
$surname string No No required parameter N/A N/A Subscribers surname

Returns

  • Subscriber ID
  • Type: AUTO_LINK
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Add a newsletter subscriber to the system (not to any particular newsletters though).
 *
 * @param  EMAIL $email The e-mail address of the subscriber
 * @param  TIME $join_time The join time
 * @param  integer $code_confirm Confirm code
 * @param  ID_TEXT $password Newsletter password (hashed)
 * @param  ID_TEXT $salt Newsletter salt
 * @param  LANGUAGE_NAME $language The language
 * @param  string $forename Subscribers forename
 * @param  string $surname Subscribers surname
 * @return AUTO_LINK Subscriber ID
 */
function add_newsletter_subscriber(string $email, int $join_time, int $code_confirm, string $password, string $salt, string $language, string $forename, string $surname) : int