Function Hook_privacy_base->anonymise
Definitions
sources/privacy.php
- Anonymise a row.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: array
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $table_name | ID_TEXT | required parameter | N/A | N/A | Table name |
| $table_details | array | required parameter | N/A | N/A | Details of the table from the info function |
| $row | array | required parameter | N/A | N/A | Row raw from the database |
| $username | ID_TEXT | Blank (empty string) | N/A | N/A | Only anonymise username fields containing this username (blank: do not filter by this) |
| $ip_addresses | array | [] | N/A | N/A | Only anonymise IP fields containing one of these IP addresses (empty: do not filter by this) |
| $member_id | ?MEMBER | Null | N/A | N/A | Only anonymise member fields containing this member ID (null: do not filter by this) |
| $email_address | string | Blank (empty string) | N/A | N/A | Only anonymise e-mail fields containing this e-mail address (blank: do not filter by this) |
| $others | array | [] | N/A | N/A | Only anonymise additional fields containing one of these strings (empty: do not filter by this) |
| $reverse_logic_return | boolean | False | N/A | N/A | Whether to anonymise on fields that do not match the provided criteria instead of those that do, and return a modified $row instead of modifying the database |
Return
- Modified row, if $reverse_logic_return was true (null: $reverse_logic_return was false)
- Type: ?array
- Set: N/A
- Range: N/A