ActionScheduler_CanceledSchedule

ActionScheduler_CanceledSchedule represents a canceled action. It explicitly has no next run, even if a scheduled date exists.

Class definition

class ActionScheduler_CanceledSchedule extends ActionScheduler_SimpleSchedule {
	public function calculate_next( DateTime $after );
	public function get_next( DateTime $after );
	public function is_recurring();
	public function __wakeup();
}

When it’s used

Use this schedule for actions that have been canceled. A canceled schedule should never yield a next run time.

Next-run calculation

  • calculate_next() returns null.
  • get_next( DateTime $after ) is overridden to always return null, even when $after is before the scheduled date.

This prevents canceled actions from being considered due, regardless of their original scheduled time.

Recurrence

  • is_recurring() returns false.

Serialization compatibility

__wakeup() maps the legacy timestamp property into scheduled_timestamp for schedules serialized before Action Scheduler 3.0.0.