\WP_Async_Request

Abstract WP_Async_Request class.

Summary

Methods

Properties

Constants

__construct()
data()
dispatch()
maybe_handle()

No public properties found

No constants found

get_query_args()
get_query_url()
get_post_args()
handle()

$prefix
$action
$identifier
$data

N/A

No private methods found

No private properties found

N/A

abstract

File: includes/lib/action-scheduler/lib/WP_Async_Request.php
Package: Background\Processing
Class hierarchy: \WP_Async_Request

Properties

$prefix

$prefix : string

Prefix

(default value: 'wp')

Type

normal

$action

$action : string

Action

(default value: 'async_request')

Type

normal

$identifier

$identifier : mixed

Identifier

Type

normal

$data

$data : array

Data

(default value: array())

Type

normal

Methods

__construct()

__construct() : mixed

Initiate new async request

Returns

mixed

data()

data(array  $data) : $this

Set data used during the request

Parameters

array

$data

Data.

Returns

$this

dispatch()

dispatch() : array|\WP_Error

Dispatch the async request

Returns

array|\WP_Error

maybe_handle()

maybe_handle() : mixed

Maybe handle

Check for correct nonce and pass to handler.

Returns

mixed

get_query_args()

get_query_args() : array

Get query args

Returns

array

get_query_url()

get_query_url() : string

Get query URL

Returns

string

get_post_args()

get_post_args() : array

Get post args

Returns

array

handle()

handle() : mixed

Handle

Override this method to perform any actions required during the async request.

Returns

mixed