Function Hook_task_privacy_purge->run
Definitions
sources/hooks/systems/tasks/privacy_purge.php
- Run the task hook.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: array
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $table_actions | array | required parameter | N/A | N/A | Map between table names and PRIVACY_METHOD_* constants |
| $username | ID_TEXT | required parameter | N/A | N/A | Username to search for (blank: none) |
| $ip_addresses | array | required parameter | N/A | N/A | List of IP addresses to search for |
| $member_id | ?MEMBER | required parameter | N/A | N/A | Member ID to search for (null: none) |
| $email_address | string | required parameter | N/A | N/A | E-mail address to search for (blank: none) |
| $others | array | required parameter | N/A | N/A | List of other strings to search for, via additional-anonymise-fields |
Return
- 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