Function Hook_task_cns_delete_member->run

Definitions

sources/hooks/systems/tasks/cns_delete_member.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
$member_id MEMBER No No required parameter N/A N/A The member being deleted
$member_id_deleting MEMBER No No required parameter N/A N/A The member doing the deleting
$also_purge boolean No No False N/A N/A Whether we are also purging their personal data

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  MEMBER $member_id The member being deleted
 * @param  MEMBER $member_id_deleting The member doing the deleting
 * @param  boolean $also_purge Whether we are also purging their personal data
 * @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(int $member_id, int $member_id_deleting, bool $also_purge = false) : ?array