Function __global->newsletter_wrap

Definitions

sources/newsletter.php

  • Apply the newsletter wrapper.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$message_tempcode Tempcode No No required parameter N/A N/A The newsletter message
$subject SHORT_TEXT No No Blank (empty string) N/A N/A The newsletter subject
$lang ?LANGUAGE_NAME No No Null N/A N/A User language (null: default site language)
$wrapper_tpl string No No NEWSLETTER_DEFAULT_FCOMCODE N/A N/A Wrapper template

Returns

  • The newsletter with wrapper
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Apply the newsletter wrapper.
 *
 * @param  Tempcode $message_tempcode The newsletter message
 * @param  SHORT_TEXT $subject The newsletter subject
 * @param  ?LANGUAGE_NAME $lang User language (null: default site language)
 * @param  string $wrapper_tpl Wrapper template
 * @return Tempcode The newsletter with wrapper
 */
function newsletter_wrap(object $message_tempcode, string $subject = '', ?string $lang = null, string $wrapper_tpl = 'NEWSLETTER_DEFAULT_FCOMCODE') : object