LLMS_Order::unschedule_recurring_payment()

Cancels a scheduled recurring payment action


Description Description

Does nothing if no payments are scheduled


Top ↑

Return Return

(void)


Top ↑

Source Source

File: includes/models/model.llms.order.php

	public function unschedule_recurring_payment() {

		if ( $this->get_next_scheduled_action_time( 'llms_charge_recurring_payment' ) ) {

			$action_args = $this->get_action_args();

			as_unschedule_action( 'llms_charge_recurring_payment', $action_args );

			/**
			 * Fired after a recurring payment is unscheduled
			 *
			 * @since 5.2.0
			 *
			 * @param LLMS_Order $order       LLMS_Order instance.
			 * @param int        $date        Timestamp of the recurring payment date UTC.
			 * @param array      $action_args Arguments passed to the scheduler.
			 */
			do_action( 'llms_charge_recurring_payment_unscheduled', $this, $action_args );

		}

	}


Top ↑

Changelog Changelog

Changelog
Version Description
4.6.0 Use $this->get_next_scheduled_action_time() to determine if the action is currently scheduled.
3.32.0 Update to use latest action-scheduler functions.
3.0.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.