LLMS_Order::get_recurring_payment_due_date_for_scheduler( string $next_payment_date = false, boolean $gmt = false )
Returns the recurring payment due date in a suitable format for the scheduler.
Parameters Parameters
- $next_payment_date
-
(string) (Optional) Next payment date. If not provided it'll be retrieved using
$this->get_next_payment_due_date().Default value: false
- $gmt
-
(boolean) (Optional) Whether the provided
$next_payment_datedate is gmt. Default isfalse. Only applies when the$next_payment_dateis provided.Default value: false
Return Return
(WP_Error|integer)
Source Source
File: includes/models/model.llms.order.php
// Unschedule the next action (does nothing if no action scheduled).
$this->unschedule_recurring_payment();
$date = $this->get_recurring_payment_due_date_for_scheduler( $next_payment_date, $gmt );
if ( is_wp_error( $date ) ) {
return $date;
}
$action_args = $this->get_action_args();
// Schedule the payment.
$action_id = as_schedule_single_action(
$date,
'llms_charge_recurring_payment',
$action_args
);
/**
* Fired after a recurring payment is scheduled
*
* @since 5.2.0
*
Expand full source code Collapse full source code View on GitHub
Changelog Changelog
| Version | Description |
|---|---|
| 5.2.0 | Introduced. |