Function Hook_cron_newsletter_periodic->newsletter_periodic_handle

Definitions

sources/hooks/systems/cron/newsletter_periodic.php

  • Send a periodic newsletter.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: int

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$periodic_row array No No required parameter N/A N/A Details of periodic newsletter
$test_run boolean No No False N/A N/A See if this needs to run

Returns

  • Time was sent (null: not sent)
  • Type: ?TIME
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Send a periodic newsletter.
 *
 * @param  array $periodic_row Details of periodic newsletter
 * @param  boolean $test_run See if this needs to run
 * @return ?TIME Time was sent (null: not sent)
 */
public function newsletter_periodic_handle(array $periodic_row, bool $test_run = false) : ?int