Function __global->newsletter_prepare

Definitions

sources/newsletter.php

  • Prepare a newsletter, with the Tempcode/Wrapper/Substitution flow.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$message_raw string No No required parameter N/A N/A The unprocessed newsletter message
&$subject SHORT_TEXT Yes No required parameter N/A N/A The newsletter subject
$lang ?LANGUAGE_NAME No No Null N/A N/A User language (null: default site language)
$forename SHORT_TEXT No No Blank (empty string) N/A N/A Subscribers forename (blank: unknown)
$surname SHORT_TEXT No No Blank (empty string) N/A N/A Subscribers surname (blank: unknown)
$name ?SHORT_TEXT No No Null N/A N/A Subscribers name (or username) (null: generic)
$email_address EMAIL No No Blank (empty string) N/A N/A Subscribers e-mail address
$send_id ID_TEXT No No Blank (empty string) N/A N/A Specially encoded ID of subscriber (begins either 'n' for newsletter subscriber, or 'm' for member - then has normal subscriber/member ID following)
$hash SHORT_TEXT No No Blank (empty string) N/A N/A Password hash of subscriber (blank: can not unsubscribe by URL)
$extra_mappings array No No [] N/A N/A Extra mappings to be substituted
$wrapper_tpl ?string No No NEWSLETTER_DEFAULT_FCOMCODE N/A N/A Wrapper template (null: do not wrap)

Returns

  • The processed newsletter message
  • Type: string
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Prepare a newsletter, with the Tempcode/Wrapper/Substitution flow.
 *
 * @param  string $message_raw The unprocessed newsletter message
 * @param  SHORT_TEXT $subject The newsletter subject
 * @param  ?LANGUAGE_NAME $lang User language (null: default site language)
 * @param  SHORT_TEXT $forename Subscribers forename (blank: unknown)
 * @param  SHORT_TEXT $surname Subscribers surname (blank: unknown)
 * @param  ?SHORT_TEXT $name Subscribers name (or username) (null: generic)
 * @param  EMAIL $email_address Subscribers e-mail address
 * @param  ID_TEXT $send_id Specially encoded ID of subscriber (begins either 'n' for newsletter subscriber, or 'm' for member - then has normal subscriber/member ID following)
 * @param  SHORT_TEXT $hash Password hash of subscriber (blank: can not unsubscribe by URL)
 * @param  array $extra_mappings Extra mappings to be substituted
 * @param  ?string $wrapper_tpl Wrapper template (null: do not wrap)
 * @return string The processed newsletter message
 */
function newsletter_prepare(string $message_raw, string &$subject, ?string $lang = null, string $forename = '', string $surname = '', ?string $name = null, string $email_address = '', string $send_id = '', string $hash = '', array $extra_mappings = [], ?string $wrapper_tpl = 'NEWSLETTER_DEFAULT_FCOMCODE') : string