Function Hook_task_notify_topics_moved->run

Definitions

sources/hooks/systems/tasks/notify_topics_moved.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
$or_list string No No required parameter N/A N/A An SQL segment of what topics are being moved
$forum_name string No No required parameter N/A N/A The name of the target forum

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  string $or_list An SQL segment of what topics are being moved
 * @param  string $forum_name The name of the target forum
 * @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(string $or_list, string $forum_name) : ?array