Ultimate Member - PHPDoc
\
Action_Scheduler
Migration
WP_CLI
Action
um
action_scheduler
admin
core
ajax
common
actions
core
rest
frontend
widgets

\ActionScheduler

Class ActionScheduler

Summary

Methods
Properties
Constants
factory()
store()
lock()
logger()
runner()
admin_view()
plugin_path()
plugin_url()
autoload()
init()
is_initialized()
__clone()
__wakeup()
get_datetime_object()
check_shutdown_hook()
No public properties found
No constants found
is_class_abstract()
is_class_migration()
is_class_cli()
No protected properties found
N/A
__construct()
$plugin_file
$factory
$data_store_initialized
N/A

Properties

$plugin_file

$plugin_file : string

Plugin file path.

Type

normal

$factory

$factory : \ActionScheduler_ActionFactory

ActionScheduler_ActionFactory instance.

Type

normal

$data_store_initialized

$data_store_initialized : bool

Data store is initialized.

Type

normal

Methods

factory()

factory() : mixed

Factory.

Returns

mixed

store()

store() : mixed

Get Store instance.

Returns

mixed

lock()

lock() : mixed

Get Lock instance.

Returns

mixed

logger()

logger() : mixed

Get Logger instance.

Returns

mixed

runner()

runner() : mixed

Get QueueRunner instance.

Returns

mixed

admin_view()

admin_view() : mixed

Get AdminView instance.

Returns

mixed

plugin_path()

plugin_path(string  $path) : string

Get the absolute system path to the plugin directory, or a file therein

Parameters

string $path

Path relative to plugin directory.

Returns

string

plugin_url()

plugin_url(string  $path) : string

Get the absolute URL to the plugin directory, or a file therein

Parameters

string $path

Path relative to plugin directory.

Returns

string

autoload()

autoload(string  $class) : mixed

Autoload.

Parameters

string $class

Class name.

Returns

mixed

init()

init(string  $plugin_file) : mixed

Initialize the plugin

Parameters

string $plugin_file

Plugin file path.

Returns

mixed

is_initialized()

is_initialized(string  $function_name = null) : bool

Check whether the AS data store has been initialized.

Parameters

string $function_name

The name of the function being called. Optional. Default null.

Returns

bool

__clone()

__clone() : mixed

Clone.

Returns

mixed

__wakeup()

__wakeup() : mixed

Wakeup.

Returns

mixed

get_datetime_object()

get_datetime_object(null|string  $when = null, string  $timezone = 'UTC') : mixed

Get DateTime object.

Parameters

null|string $when

Date/time string.
string $timezone

Timezone string.

Returns

mixed

check_shutdown_hook()

check_shutdown_hook(string  $function_name) : mixed

Issue deprecated warning if an Action Scheduler function is called in the shutdown hook.

Parameters

string $function_name

The name of the function being called.

Returns

mixed

is_class_abstract()

is_class_abstract(string  $class) : bool

Determine if the class is one of our abstract classes.

Parameters

string $class

The class name.

Returns

bool

is_class_migration()

is_class_migration(string  $class) : bool

Determine if the class is one of our migration classes.

Parameters

string $class

The class name.

Returns

bool

is_class_cli()

is_class_cli(string  $class) : bool

Determine if the class is one of our WP CLI classes.

Parameters

string $class

The class name.

Returns

bool

__construct()

__construct() : mixed

Construct.

Returns

mixed