mycred_delete_recurring_payout
Description
Deletes a given recurring payout in the Banking add-on.
This function is only available if the Banking add-on is enabled.
Available since version 1.7
Returns
(bool) TRUE if the schedule was deleted else FALSE.
Parameters
| Param | Type | Required | Description | |
|---|---|---|---|---|
function mycred_delete_recurring_payout( |
||||
$id |
string | Yes | The recurring payout ID. |
|
$point_type |
string | No | Optional point type key if we are not deleting a recurring payout for the default point type. |
|
) { ... } |
||||
Examples
Example 1: Delete the recurring payout with the ID 1.
$payout = 1; mycred_delete_recurring_payout( $payout );
