Scheduler extends Component

Handles event scheduling.

Table of Contents

__construct()  : mixed
Class constructor.
add_action()  : mixed
Schedules an action.
remove_action()  : mixed
Unschedules an action.
run_event()  : mixed
Dry run event.
schedule_events()  : mixed
Schedules events.
unschedule_events()  : mixed
Unschedules events.
boot()  : mixed
Bootstraps component properties.
run_events()  : mixed
Dry run events.
set_callbacks()  : mixed
Sets the action and filter callbacks.
set_property()  : mixed
Sets a property value.

Methods

__construct()

Class constructor.

public __construct([array<string|int, mixed> $args = [] ]) : mixed
Parameters
$args : array<string|int, mixed> = []

Component arguments.

Return values
mixed —

add_action()

Schedules an action.

public add_action(string $hook[, array<string|int, mixed> $args = [] ][, int $time = null ][, mixed $interval = null ]) : mixed
Parameters
$hook : string

Hook name.

$args : array<string|int, mixed> = []

Hook arguments.

$time : int = null

Time to execute.

$interval : mixed = null

Recurring interval.

Return values
mixed —

remove_action()

Unschedules an action.

public remove_action(string $hook[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$hook : string

Hook name.

$args : array<string|int, mixed> = []

Hook arguments.

Return values
mixed —

set_callbacks()

Sets the action and filter callbacks.

protected final set_callbacks(array<string|int, mixed> $callbacks) : mixed
Parameters
$callbacks : array<string|int, mixed>

Callback arguments.

Return values
mixed —

set_property()

Sets a property value.

protected final set_property(string $name, mixed $value[, string $prefix = '' ]) : mixed
Parameters
$name : string

Property name.

$value : mixed

Property value.

$prefix : string = ''

Method prefix.

Return values
mixed —