ActionScheduler_FinishedAction

Represents a stored action that is already finished. It is used for actions whose stored status is not pending or canceled (for example, complete, failed, or in-progress), and it intentionally does not execute.

Source: classes/actions/ActionScheduler_FinishedAction.php

Class Hierarchy

ActionScheduler_Action
└── ActionScheduler_FinishedAction

Methods

public function execute()

Overrides the base implementation and performs no work. Finished actions do not trigger their hooks.

public function is_finished()

Returns true, marking this action as finished for store logic that checks ActionScheduler_Action::is_finished().

Usage Notes

ActionScheduler_ActionFactory::get_stored_action() chooses this class for any status other than pending or canceled. This means:

  • complete actions are represented as finished actions.
  • failed actions are represented as finished actions.
  • in-progress actions are also represented as finished actions when loaded from the store.

Finished actions do not execute and always report is_finished() as true.