Function __global->points_transactions_reverse_all
Definitions
sources/points2.php
- Fully reverse all points transactions matching the provided criteria.You must provide at least one criteria to prevent accidental reversal of the entire ledger.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: array
Parameters
Name | Type | Default | Set | Range | Description |
---|---|---|---|---|---|
$send_notifications | ?boolean | False | N/A | N/A | Whether to send notifications for these transaction reversals (false: only the staff get it) (true: both the member and staff get it) (null: neither the member nor staff get it) |
$sending_member | ?MEMBER | Null | N/A | N/A | Filter by member who sent the points (null: do not filter) |
$receiving_member | ?MEMBER | Null | N/A | N/A | Filter by member who received the points (null: do not filter) |
$t_type | ID_TEXT | Blank (empty string) | N/A | N/A | Filter by content type (blank: do not filter) |
$t_subtype | ID_TEXT | Blank (empty string) | N/A | N/A | Filter by subtype / action (blank: do not filter) |
$t_type_id | ID_TEXT | Blank (empty string) | N/A | N/A | Filter by content ID (blank: do not filter) |
Return
- An array of duples containing the ID of the original transaction, and null if the transaction could not be reversed or an array tuple of ID of the new transaction reversing, a boolean whether an escrow was also cancelled during the reversal, and an array of additional point transactions that were reversed because they had a reverse_link to this one
- Type: array
- Set: N/A
- Range: N/A