Function Hook_task_dispatch_notification->run

Definitions

sources/hooks/systems/tasks/dispatch_notification.php

  • Run the task hook.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$dispatcher object No No required parameter N/A N/A The notification dispatch object (pre-filled with details of the notification to send)
$csss array No No [] N/A N/A List of CSS files to require

Returns

  • A tuple of at least 2: Return mime-type, content (either Tempcode, or a string, or a filename and file-path pair to a temporary file), map of HTTP headers if transferring immediately, map of ini_set commands if transferring immediately (null: show standard success message)
  • Type: ?array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Run the task hook.
 *
 * @param  object $dispatcher The notification dispatch object (pre-filled with details of the notification to send)
 * @param  array $csss List of CSS files to require
 * @return ?array A tuple of at least 2: Return mime-type, content (either Tempcode, or a string, or a filename and file-path pair to a temporary file), map of HTTP headers if transferring immediately, map of ini_set commands if transferring immediately (null: show standard success message)
 */
public function run(object $dispatcher, array $csss = []) : ?array