mycred_get_recurring_payout_schedules

Description

This function will return all currently existing recurring payout schedules in the Banking add-on.

This function is only available if the Banking add-on is enabled.

Available since version 1.7

Returns

(array) Returns an associative array of schedule IDs and the associated setup for each schedule.

Parameters

Param Type Required Description
function mycred_get_recurring_payout_schedules(
$point_type string No

The point type key to return schedules for. Defaults to the default point type.

) { ... }

Examples

Example 1: Count the total number of recurring schedules currently in use on our website.

$schedules = mycred_get_recurring_payout_schedules();

printf( 'There are %d recurring payouts currently running on this website', count( $schedule ) );