Menu

## ActionScheduler_CanceledAction extends ActionScheduler_FinishedAction
in package

ActionScheduler_CanceledAction.php : 9

Class ActionScheduler_CanceledAction

Stored action which was canceled and therefore acts like a finished action but should always return a null schedule, regardless of schedule passed to its constructor.

### Table of Contents

$args : mixed
$group : mixed
$hook : mixed
$schedule : ActionScheduler_Schedule
__construct() : mixed
execute() : mixed
get_args() : mixed
get_group() : string
get_hook() : mixed
get_schedule() : ActionScheduler_Schedule
is_finished() : bool
set_args() : mixed
set_group() : mixed
set_hook() : mixed
set_schedule() : mixed

### Properties

#### $args

ActionScheduler_Action.php : 8
`protected mixed $args = array()`

#### $group

ActionScheduler_Action.php : 11
`protected mixed $group = ''`

#### $hook

ActionScheduler_Action.php : 7
`protected mixed $hook = ''`

#### $schedule

ActionScheduler_Action.php : 10
`protected ActionScheduler_Schedule $schedule = NULL`

### Methods

#### __construct()

ActionScheduler_CanceledAction.php : 17
`public __construct(string $hook[, array<string|int, mixed> $args = array() ][, ActionScheduler_Schedule $schedule = null ][, string $group = '' ]) : mixed`

##### Parameters

$hook : string
$args : array<string|int, mixed> = array()
$schedule : ActionScheduler_Schedule = null
$group : string = ''

##### Return values

mixed —

#### execute()

ActionScheduler_Action.php : 21
`public execute() : mixed`

##### Return values

mixed —

#### get_args()

ActionScheduler_Action.php : 51
`public get_args() : mixed`

##### Return values

mixed —

#### get_group()

ActionScheduler_Action.php : 65
`public get_group() : string`

##### Return values

string —

#### get_hook()

ActionScheduler_Action.php : 32
`public get_hook() : mixed`

##### Return values

mixed —

#### get_schedule()

ActionScheduler_Action.php : 43
`public get_schedule() : ActionScheduler_Schedule`

##### Return values

ActionScheduler_Schedule —

#### is_finished()

ActionScheduler_Action.php : 72
`public is_finished() : bool`

##### Return values

bool —

If the action has been finished

#### set_args()

ActionScheduler_Action.php : 47
`protected set_args(array<string|int, mixed> $args) : mixed`

##### Parameters

$args : array<string|int, mixed>

##### Return values

mixed —

#### set_group()

ActionScheduler_Action.php : 58
`protected set_group(string $group) : mixed`

##### Parameters

$group : string

##### Return values

mixed —

#### set_hook()

ActionScheduler_Action.php : 28
`protected set_hook(string $hook) : mixed`

##### Parameters

$hook : string

##### Return values

mixed —

#### set_schedule()

ActionScheduler_Action.php : 36
`protected set_schedule(ActionScheduler_Schedule $schedule) : mixed`

##### Parameters

$schedule : ActionScheduler_Schedule

##### Return values

mixed —

## Search results