Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WP Async Request

[2] Fix | Delete

[3] Fix | Delete

* @package WP-Background-Processing

[4] Fix | Delete

[5] Fix | Delete

[6] Fix | Delete

Library URI: https://github.com/deliciousbrains/wp-background-processing/blob/fbbc56f2480910d7959972ec9ec0819a13c6150a/classes/wp-async-request.php

[7] Fix | Delete

Author: Delicious Brains Inc.

[8] Fix | Delete

Author URI: https://deliciousbrains.com/

[9] Fix | Delete

License: GNU General Public License v2.0

[10] Fix | Delete

License URI: https://github.com/deliciousbrains/wp-background-processing/commit/126d7945dd3d39f39cb6488ca08fe1fb66cb351a

[11] Fix | Delete

[12] Fix | Delete

[13] Fix | Delete

if ( ! class_exists( 'WP_Async_Request' ) ) {

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* Abstract WP_Async_Request class.

[17] Fix | Delete

[18] Fix | Delete

* @abstract

[19] Fix | Delete

[20] Fix | Delete

abstract class WP_Async_Request {

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* Prefix

[24] Fix | Delete

[25] Fix | Delete

* (default value: 'wp')

[26] Fix | Delete

[27] Fix | Delete

* @var string

[28] Fix | Delete

* @access protected

[29] Fix | Delete

[30] Fix | Delete

protected $prefix = 'wp';

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* Action

[34] Fix | Delete

[35] Fix | Delete

* (default value: 'async_request')

[36] Fix | Delete

[37] Fix | Delete

* @var string

[38] Fix | Delete

* @access protected

[39] Fix | Delete

[40] Fix | Delete

protected $action = 'async_request';

[41] Fix | Delete

[42] Fix | Delete

/**

[43] Fix | Delete

* Identifier

[44] Fix | Delete

[45] Fix | Delete

* @var mixed

[46] Fix | Delete

* @access protected

[47] Fix | Delete

[48] Fix | Delete

protected $identifier;

[49] Fix | Delete

[50] Fix | Delete

/**

[51] Fix | Delete

* Data

[52] Fix | Delete

[53] Fix | Delete

* (default value: array())

[54] Fix | Delete

[55] Fix | Delete

* @var array

[56] Fix | Delete

* @access protected

[57] Fix | Delete

[58] Fix | Delete

protected $data = array();

[59] Fix | Delete

[60] Fix | Delete

/**

[61] Fix | Delete

* Initiate new async request

[62] Fix | Delete

[63] Fix | Delete

public function __construct() {

[64] Fix | Delete

$this->identifier = $this->prefix . '_' . $this->action;

[65] Fix | Delete

[66] Fix | Delete

add_action( 'wp_ajax_' . $this->identifier, array( $this, 'maybe_handle' ) );

[67] Fix | Delete

add_action( 'wp_ajax_nopriv_' . $this->identifier, array( $this, 'maybe_handle' ) );

[68] Fix | Delete

}

[69] Fix | Delete

[70] Fix | Delete

/**

[71] Fix | Delete

* Set data used during the request

[72] Fix | Delete

[73] Fix | Delete

* @param array $data Data.

[74] Fix | Delete

[75] Fix | Delete

* @return $this

[76] Fix | Delete

[77] Fix | Delete

public function data( $data ) {

[78] Fix | Delete

$this->data = $data;

[79] Fix | Delete

[80] Fix | Delete

return $this;

[81] Fix | Delete

}

[82] Fix | Delete

[83] Fix | Delete

/**

[84] Fix | Delete

* Dispatch the async request

[85] Fix | Delete

[86] Fix | Delete

* @return array|WP_Error

[87] Fix | Delete

[88] Fix | Delete

public function dispatch() {

[89] Fix | Delete

$url = add_query_arg( $this->get_query_args(), $this->get_query_url() );

[90] Fix | Delete

$args = $this->get_post_args();

[91] Fix | Delete

[92] Fix | Delete

return wp_remote_post( esc_url_raw( $url ), $args );

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

/**

[96] Fix | Delete

* Get query args

[97] Fix | Delete

[98] Fix | Delete

* @return array

[99] Fix | Delete

[100] Fix | Delete

protected function get_query_args() {

[101] Fix | Delete

if ( property_exists( $this, 'query_args' ) ) {

[102] Fix | Delete

return $this->query_args;

[103] Fix | Delete

}

[104] Fix | Delete

[105] Fix | Delete

$args = array(

[106] Fix | Delete

'action' => $this->identifier,

[107] Fix | Delete

'nonce' => wp_create_nonce( $this->identifier ),

[108] Fix | Delete

);

[109] Fix | Delete

[110] Fix | Delete

/**

[111] Fix | Delete

* Filters the post arguments used during an async request.

[112] Fix | Delete

[113] Fix | Delete

* @param array $url

[114] Fix | Delete

[115] Fix | Delete

return apply_filters( $this->identifier . '_query_args', $args );

[116] Fix | Delete

}

[117] Fix | Delete

[118] Fix | Delete

/**

[119] Fix | Delete

* Get query URL

[120] Fix | Delete

[121] Fix | Delete

* @return string

[122] Fix | Delete

[123] Fix | Delete

protected function get_query_url() {

[124] Fix | Delete

if ( property_exists( $this, 'query_url' ) ) {

[125] Fix | Delete

return $this->query_url;

[126] Fix | Delete

}

[127] Fix | Delete

[128] Fix | Delete

$url = admin_url( 'admin-ajax.php' );

[129] Fix | Delete

[130] Fix | Delete

/**

[131] Fix | Delete

* Filters the post arguments used during an async request.

[132] Fix | Delete

[133] Fix | Delete

* @param string $url

[134] Fix | Delete

[135] Fix | Delete

return apply_filters( $this->identifier . '_query_url', $url );

[136] Fix | Delete

}

[137] Fix | Delete

[138] Fix | Delete

/**

[139] Fix | Delete

* Get post args

[140] Fix | Delete

[141] Fix | Delete

* @return array

[142] Fix | Delete

[143] Fix | Delete

protected function get_post_args() {

[144] Fix | Delete

if ( property_exists( $this, 'post_args' ) ) {

[145] Fix | Delete

return $this->post_args;

[146] Fix | Delete

}

[147] Fix | Delete

[148] Fix | Delete

$args = array(

[149] Fix | Delete

'timeout' => 0.01,

[150] Fix | Delete

'blocking' => false,

[151] Fix | Delete

'body' => $this->data,

[152] Fix | Delete

'cookies' => $_COOKIE,

[153] Fix | Delete

'sslverify' => apply_filters( 'https_local_ssl_verify', false ),

[154] Fix | Delete

);

[155] Fix | Delete

[156] Fix | Delete

/**

[157] Fix | Delete

* Filters the post arguments used during an async request.

[158] Fix | Delete

[159] Fix | Delete

* @param array $args

[160] Fix | Delete

[161] Fix | Delete

return apply_filters( $this->identifier . '_post_args', $args );

[162] Fix | Delete

}

[163] Fix | Delete

[164] Fix | Delete

/**

[165] Fix | Delete

* Maybe handle

[166] Fix | Delete

[167] Fix | Delete

* Check for correct nonce and pass to handler.

[168] Fix | Delete

[169] Fix | Delete

public function maybe_handle() {

[170] Fix | Delete

// Don't lock up other requests while processing

[171] Fix | Delete

session_write_close();

[172] Fix | Delete

[173] Fix | Delete

check_ajax_referer( $this->identifier, 'nonce' );

[174] Fix | Delete

[175] Fix | Delete

$this->handle();

[176] Fix | Delete

[177] Fix | Delete

wp_die();

[178] Fix | Delete

}

[179] Fix | Delete

[180] Fix | Delete

/**

[181] Fix | Delete

* Handle

[182] Fix | Delete

[183] Fix | Delete

* Override this method to perform any actions required

[184] Fix | Delete

* during the async request.

[185] Fix | Delete

[186] Fix | Delete

abstract protected function handle();

[187] Fix | Delete

[188] Fix | Delete

}

[189] Fix | Delete

}

[190] Fix | Delete

[191] Fix | Delete