<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* The plugin API class.

[2] Fix | Delete

*

[3] Fix | Delete

* @since 1.1.3

[4] Fix | Delete

* @since 1.4 Moved into /inc

[5] Fix | Delete

* @package LiteSpeed

[6] Fix | Delete

* @subpackage LiteSpeed/inc

[7] Fix | Delete

* @author LiteSpeed Technologies <info@litespeedtech.com>

[8] Fix | Delete

*/

[9] Fix | Delete

namespace LiteSpeed;

[10] Fix | Delete

[11] Fix | Delete

defined('WPINC') || exit();

[12] Fix | Delete

[13] Fix | Delete

class API extends Base

[14] Fix | Delete

{

[15] Fix | Delete

const VERSION = Core::VER;

[16] Fix | Delete

[17] Fix | Delete

const TYPE_FEED = Tag::TYPE_FEED;

[18] Fix | Delete

const TYPE_FRONTPAGE = Tag::TYPE_FRONTPAGE;

[19] Fix | Delete

const TYPE_HOME = Tag::TYPE_HOME;

[20] Fix | Delete

const TYPE_PAGES = Tag::TYPE_PAGES;

[21] Fix | Delete

const TYPE_PAGES_WITH_RECENT_POSTS = Tag::TYPE_PAGES_WITH_RECENT_POSTS;

[22] Fix | Delete

const TYPE_HTTP = Tag::TYPE_HTTP;

[23] Fix | Delete

const TYPE_ARCHIVE_POSTTYPE = Tag::TYPE_ARCHIVE_POSTTYPE;

[24] Fix | Delete

const TYPE_ARCHIVE_TERM = Tag::TYPE_ARCHIVE_TERM;

[25] Fix | Delete

const TYPE_AUTHOR = Tag::TYPE_AUTHOR;

[26] Fix | Delete

const TYPE_ARCHIVE_DATE = Tag::TYPE_ARCHIVE_DATE;

[27] Fix | Delete

const TYPE_BLOG = Tag::TYPE_BLOG;

[28] Fix | Delete

const TYPE_LOGIN = Tag::TYPE_LOGIN;

[29] Fix | Delete

const TYPE_URL = Tag::TYPE_URL;

[30] Fix | Delete

[31] Fix | Delete

const TYPE_ESI = Tag::TYPE_ESI;

[32] Fix | Delete

[33] Fix | Delete

const PARAM_NAME = ESI::PARAM_NAME;

[34] Fix | Delete

const WIDGET_O_ESIENABLE = ESI::WIDGET_O_ESIENABLE;

[35] Fix | Delete

const WIDGET_O_TTL = ESI::WIDGET_O_TTL;

[36] Fix | Delete

[37] Fix | Delete

/**

[38] Fix | Delete

* Instance

[39] Fix | Delete

*

[40] Fix | Delete

* @since 3.0

[41] Fix | Delete

*/

[42] Fix | Delete

public function __construct()

[43] Fix | Delete

{

[44] Fix | Delete

}

[45] Fix | Delete

[46] Fix | Delete

/**

[47] Fix | Delete

* Define hooks to be used in other plugins.

[48] Fix | Delete

*

[49] Fix | Delete

* The benefit to use hooks other than functions is no need to detach if LSCWP enabled and function existed or not anymore

[50] Fix | Delete

*

[51] Fix | Delete

* @since 3.0

[52] Fix | Delete

*/

[53] Fix | Delete

public function init()

[54] Fix | Delete

{

[55] Fix | Delete

/**

[56] Fix | Delete

* Init

[57] Fix | Delete

*/

[58] Fix | Delete

// Action `litespeed_init` // @previous API::hook_init( $hook )

[59] Fix | Delete

[60] Fix | Delete

/**

[61] Fix | Delete

* Conf

[62] Fix | Delete

*/

[63] Fix | Delete

add_filter('litespeed_conf', array($this, 'conf')); // @previous API::config($id)

[64] Fix | Delete

// Action `litespeed_conf_append` // @previous API::conf_append( $name, $default )

[65] Fix | Delete

add_action('litespeed_conf_multi_switch', __NAMESPACE__ . '\Base::set_multi_switch', 10, 2);

[66] Fix | Delete

// Action ``litespeed_conf_force` // @previous API::force_option( $k, $v )

[67] Fix | Delete

[68] Fix | Delete

/**

[69] Fix | Delete

* Cache Control Hooks

[70] Fix | Delete

*/

[71] Fix | Delete

// Action `litespeed_control_finalize` // @previous API::hook_control($tags) && action `litespeed_api_control`

[72] Fix | Delete

add_action('litespeed_control_set_private', __NAMESPACE__ . '\Control::set_private'); // @previous API::set_cache_private()

[73] Fix | Delete

add_action('litespeed_control_set_nocache', __NAMESPACE__ . '\Control::set_nocache'); // @previous API::set_nocache( $reason = false )

[74] Fix | Delete

add_action('litespeed_control_set_cacheable', array($this, 'set_cacheable')); // Might needed if not call hook `wp` // @previous API::set_cacheable( $reason )

[75] Fix | Delete

add_action('litespeed_control_force_cacheable', __NAMESPACE__ . '\Control::force_cacheable'); // Set cache status to force cacheable ( Will ignore most kinds of non-cacheable conditions ) // @previous API::set_force_cacheable( $reason )

[76] Fix | Delete

add_action('litespeed_control_force_public', __NAMESPACE__ . '\Control::set_public_forced'); // Set cache to force public cache if cacheable ( Will ignore most kinds of non-cacheable conditions ) // @previous API::set_force_public( $reason )

[77] Fix | Delete

add_filter('litespeed_control_cacheable', __NAMESPACE__ . '\Control::is_cacheable', 3); // Note: Read-Only. Directly append to this filter won't work. Call actions above to set cacheable or not // @previous API::not_cacheable()

[78] Fix | Delete

add_action('litespeed_control_set_ttl', __NAMESPACE__ . '\Control::set_custom_ttl', 10, 2); // @previous API::set_ttl( $val )

[79] Fix | Delete

add_filter('litespeed_control_ttl', array($this, 'get_ttl'), 3); // @previous API::get_ttl()

[80] Fix | Delete

[81] Fix | Delete

/**

[82] Fix | Delete

* Tag Hooks

[83] Fix | Delete

*/

[84] Fix | Delete

// Action `litespeed_tag_finalize` // @previous API::hook_tag( $hook )

[85] Fix | Delete

add_action('litespeed_tag', __NAMESPACE__ . '\Tag::add'); // Shorter alias of `litespeed_tag_add`

[86] Fix | Delete

add_action('litespeed_tag_post', __NAMESPACE__ . '\Tag::add_post'); // Shorter alias of `litespeed_tag_add_post`

[87] Fix | Delete

add_action('litespeed_tag_widget', __NAMESPACE__ . '\Tag::add_widget'); // Shorter alias of `litespeed_tag_add_widget`

[88] Fix | Delete

add_action('litespeed_tag_private', __NAMESPACE__ . '\Tag::add_private'); // Shorter alias of `litespeed_tag_add_private`

[89] Fix | Delete

add_action('litespeed_tag_private_esi', __NAMESPACE__ . '\Tag::add_private_esi'); // Shorter alias of `litespeed_tag_add_private_esi`

[90] Fix | Delete

[91] Fix | Delete

add_action('litespeed_tag_add', __NAMESPACE__ . '\Tag::add'); // @previous API::tag_add( $tag )

[92] Fix | Delete

add_action('litespeed_tag_add_post', __NAMESPACE__ . '\Tag::add_post');

[93] Fix | Delete

add_action('litespeed_tag_add_widget', __NAMESPACE__ . '\Tag::add_widget');

[94] Fix | Delete

add_action('litespeed_tag_add_private', __NAMESPACE__ . '\Tag::add_private'); // @previous API::tag_add_private( $tags )

[95] Fix | Delete

add_action('litespeed_tag_add_private_esi', __NAMESPACE__ . '\Tag::add_private_esi');

[96] Fix | Delete

[97] Fix | Delete

/**

[98] Fix | Delete

* Purge Hooks

[99] Fix | Delete

*/

[100] Fix | Delete

// Action `litespeed_purge_finalize` // @previous API::hook_purge($tags)

[101] Fix | Delete

add_action('litespeed_purge', __NAMESPACE__ . '\Purge::add'); // @previous API::purge($tags)

[102] Fix | Delete

add_action('litespeed_purge_all', __NAMESPACE__ . '\Purge::purge_all');

[103] Fix | Delete

add_action('litespeed_purge_post', array($this, 'purge_post')); // @previous API::purge_post( $pid )

[104] Fix | Delete

add_action('litespeed_purge_posttype', __NAMESPACE__ . '\Purge::purge_posttype');

[105] Fix | Delete

add_action('litespeed_purge_url', array($this, 'purge_url'));

[106] Fix | Delete

add_action('litespeed_purge_widget', __NAMESPACE__ . '\Purge::purge_widget');

[107] Fix | Delete

add_action('litespeed_purge_esi', __NAMESPACE__ . '\Purge::purge_esi');

[108] Fix | Delete

add_action('litespeed_purge_private', __NAMESPACE__ . '\Purge::add_private'); // @previous API::purge_private( $tags )

[109] Fix | Delete

add_action('litespeed_purge_private_esi', __NAMESPACE__ . '\Purge::add_private_esi');

[110] Fix | Delete

add_action('litespeed_purge_private_all', __NAMESPACE__ . '\Purge::add_private_all'); // @previous API::purge_private_all()

[111] Fix | Delete

// Action `litespeed_api_purge_post` // Triggered when purge a post // @previous API::hook_purge_post($hook)

[112] Fix | Delete

// Action `litespeed_purged_all` // Triggered after purged all.

[113] Fix | Delete

add_action('litespeed_purge_all_object', __NAMESPACE__ . '\Purge::purge_all_object');

[114] Fix | Delete

add_action('litespeed_purge_ucss', __NAMESPACE__ . '\Purge::purge_ucss');

[115] Fix | Delete

[116] Fix | Delete

/**

[117] Fix | Delete

* ESI

[118] Fix | Delete

*/

[119] Fix | Delete

// Action `litespeed_nonce` // @previous API::nonce_action( $action ) & API::nonce( $action = -1, $defence_for_html_filter = true ) // NOTE: only available after `init` hook

[120] Fix | Delete

add_filter('litespeed_esi_status', array($this, 'esi_enabled')); // Get ESI enable status // @previous API::esi_enabled()

[121] Fix | Delete

add_filter('litespeed_esi_url', array($this, 'sub_esi_block'), 10, 8); // Generate ESI block url // @previous API::esi_url( $block_id, $wrapper, $params = array(), $control = 'private,no-vary', $silence = false, $preserved = false, $svar = false, $inline_val = false )

[122] Fix | Delete

// Filter `litespeed_widget_default_options` // Hook widget default settings value. Currently used in Woo 3rd // @previous API::hook_widget_default_options( $hook )

[123] Fix | Delete

// Filter `litespeed_esi_params` // @previous API::hook_esi_param( $hook )

[124] Fix | Delete

// Action `litespeed_tpl_normal` // @previous API::hook_tpl_not_esi($hook) && Action `litespeed_is_not_esi_template`

[125] Fix | Delete

// Action `litespeed_esi_load-$block` // @usage add_action( 'litespeed_esi_load-' . $block, $hook ) // @previous API::hook_tpl_esi($block, $hook)

[126] Fix | Delete

add_action('litespeed_esi_combine', __NAMESPACE__ . '\ESI::combine');

[127] Fix | Delete

[128] Fix | Delete

/**

[129] Fix | Delete

* Vary

[130] Fix | Delete

*

[131] Fix | Delete

* To modify default vary, There are two ways: Action `litespeed_vary_append` or Filter `litespeed_vary`

[132] Fix | Delete

*/

[133] Fix | Delete

add_action('litespeed_vary_ajax_force', __NAMESPACE__ . '\Vary::can_ajax_vary'); // API::force_vary() -> Action `litespeed_vary_ajax_force` // Force finalize vary even if its in an AJAX call

[134] Fix | Delete

// Filter `litespeed_vary_curr_cookies` to generate current in use vary, which will be used for response vary header.

[135] Fix | Delete

// Filter `litespeed_vary_cookies` to register the final vary cookies, which will be written to rewrite rule. (litespeed_vary_curr_cookies are always equal to or less than litespeed_vary_cookies)

[136] Fix | Delete

// Filter `litespeed_vary` // Previous API::hook_vary_finalize( $hook )

[137] Fix | Delete

add_action('litespeed_vary_no', __NAMESPACE__ . '\Control::set_no_vary'); // API::set_cache_no_vary() -> Action `litespeed_vary_no` // Set cache status to no vary

[138] Fix | Delete

[139] Fix | Delete

// add_filter( 'litespeed_is_mobile', __NAMESPACE__ . '\Control::is_mobile' ); // API::set_mobile() -> Filter `litespeed_is_mobile`

[140] Fix | Delete

[141] Fix | Delete

/**

[142] Fix | Delete

* Cloud

[143] Fix | Delete

*/

[144] Fix | Delete

add_filter('litespeed_is_from_cloud', array($this, 'is_from_cloud')); // Check if current request is from QC (usually its to check REST access) // @see https://wordpress.org/support/topic/image-optimization-not-working-3/

[145] Fix | Delete

[146] Fix | Delete

/**

[147] Fix | Delete

* Media

[148] Fix | Delete

*/

[149] Fix | Delete

add_action('litespeed_media_reset', __NAMESPACE__ . '\Media::delete_attachment'); // Reset one media row

[150] Fix | Delete

[151] Fix | Delete

/**

[152] Fix | Delete

* GUI

[153] Fix | Delete

*/

[154] Fix | Delete

// API::clean_wrapper_begin( $counter = false ) -> Filter `litespeed_clean_wrapper_begin` // Start a to-be-removed html wrapper

[155] Fix | Delete

add_filter('litespeed_clean_wrapper_begin', __NAMESPACE__ . '\GUI::clean_wrapper_begin');

[156] Fix | Delete

// API::clean_wrapper_end( $counter = false ) -> Filter `litespeed_clean_wrapper_end` // End a to-be-removed html wrapper

[157] Fix | Delete

add_filter('litespeed_clean_wrapper_end', __NAMESPACE__ . '\GUI::clean_wrapper_end');

[158] Fix | Delete

[159] Fix | Delete

/**

[160] Fix | Delete

* Mist

[161] Fix | Delete

*/

[162] Fix | Delete

add_action('litespeed_debug', __NAMESPACE__ . '\Debug2::debug', 10, 2); // API::debug()-> Action `litespeed_debug`

[163] Fix | Delete

add_action('litespeed_debug2', __NAMESPACE__ . '\Debug2::debug2', 10, 2); // API::debug2()-> Action `litespeed_debug2`

[164] Fix | Delete

add_action('litespeed_disable_all', array($this, '_disable_all')); // API::disable_all( $reason ) -> Action `litespeed_disable_all`

[165] Fix | Delete

[166] Fix | Delete

add_action('litspeed_after_admin_init', array($this, '_after_admin_init'));

[167] Fix | Delete

}

[168] Fix | Delete

[169] Fix | Delete

/**

[170] Fix | Delete

* API for admin related

[171] Fix | Delete

*

[172] Fix | Delete

* @since 3.0

[173] Fix | Delete

* @access public

[174] Fix | Delete

*/

[175] Fix | Delete

public function _after_admin_init()

[176] Fix | Delete

{

[177] Fix | Delete

/**

[178] Fix | Delete

* GUI

[179] Fix | Delete

*/

[180] Fix | Delete

add_action('litespeed_setting_enroll', array($this->cls('Admin_Display'), 'enroll'), 10, 4); // API::enroll( $id ) // Register a field in setting form to save

[181] Fix | Delete

add_action('litespeed_build_switch', array($this->cls('Admin_Display'), 'build_switch')); // API::build_switch( $id ) // Build a switch div html snippet

[182] Fix | Delete

// API::hook_setting_content( $hook, $priority = 10, $args = 1 ) -> Action `litespeed_settings_content`

[183] Fix | Delete

// API::hook_setting_tab( $hook, $priority = 10, $args = 1 ) -> Action `litespeed_settings_tab`

[184] Fix | Delete

}

[185] Fix | Delete

[186] Fix | Delete

/**

[187] Fix | Delete

* Disable All (Note: Not for direct call, always use Hooks)

[188] Fix | Delete

*

[189] Fix | Delete

* @since 2.9.7.2

[190] Fix | Delete

* @access public

[191] Fix | Delete

*/

[192] Fix | Delete

public function _disable_all($reason)

[193] Fix | Delete

{

[194] Fix | Delete

do_action('litespeed_debug', '[API] Disabled_all due to ' . $reason);

[195] Fix | Delete

[196] Fix | Delete

!defined('LITESPEED_DISABLE_ALL') && define('LITESPEED_DISABLE_ALL', true);

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete

/**

[200] Fix | Delete

* @since 3.0

[201] Fix | Delete

*/

[202] Fix | Delete

public static function vary_append_commenter()

[203] Fix | Delete

{

[204] Fix | Delete

Vary::cls()->append_commenter();

[205] Fix | Delete

}

[206] Fix | Delete

[207] Fix | Delete

/**

[208] Fix | Delete

* Check if is from Cloud

[209] Fix | Delete

*

[210] Fix | Delete

* @since 4.2

[211] Fix | Delete

*/

[212] Fix | Delete

public function is_from_cloud()

[213] Fix | Delete

{

[214] Fix | Delete

return $this->cls('Cloud')->is_from_cloud();

[215] Fix | Delete

}

[216] Fix | Delete

[217] Fix | Delete

public function purge_post($pid)

[218] Fix | Delete

{

[219] Fix | Delete

$this->cls('Purge')->purge_post($pid);

[220] Fix | Delete

}

[221] Fix | Delete

[222] Fix | Delete

public function purge_url($url)

[223] Fix | Delete

{

[224] Fix | Delete

$this->cls('Purge')->purge_url($url);

[225] Fix | Delete

}

[226] Fix | Delete

[227] Fix | Delete

public function set_cacheable($reason = false)

[228] Fix | Delete

{

[229] Fix | Delete

$this->cls('Control')->set_cacheable($reason);

[230] Fix | Delete

}

[231] Fix | Delete

[232] Fix | Delete

public function esi_enabled()

[233] Fix | Delete

{

[234] Fix | Delete

return $this->cls('Router')->esi_enabled();

[235] Fix | Delete

}

[236] Fix | Delete

[237] Fix | Delete

public function get_ttl()

[238] Fix | Delete

{

[239] Fix | Delete

return $this->cls('Control')->get_ttl();

[240] Fix | Delete

}

[241] Fix | Delete

[242] Fix | Delete

public function sub_esi_block(

[243] Fix | Delete

$block_id,

[244] Fix | Delete

$wrapper,

[245] Fix | Delete

$params = array(),

[246] Fix | Delete

$control = 'private,no-vary',

[247] Fix | Delete

$silence = false,

[248] Fix | Delete

$preserved = false,

[249] Fix | Delete

$svar = false,

[250] Fix | Delete

$inline_param = array()

[251] Fix | Delete

) {

[252] Fix | Delete

return $this->cls('ESI')->sub_esi_block($block_id, $wrapper, $params, $control, $silence, $preserved, $svar, $inline_param);

[253] Fix | Delete

}

[254] Fix | Delete

}

[255] Fix | Delete

[256] Fix | Delete