kinsta_extension
extends abstract_extension
in package
implements
kinsta_cache
Uses
kinsta_cache_api
Extension: kinsta_extension - kinsta API - ATP Custom Plugin for WordPress
Tags
Interfaces, Classes, Traits and Enums
- kinsta_cache
- Kinsta Cache API
Table of Contents
- KINSTA_LOCAL = true
- VERSION = '25.0527.1'
- __construct() : mixed
- constructor method
- addActionsAndFilters() : mixed
- Add filters and actions - called from main plugin
- admin_options_settings() : mixed
- register options on options_settings_page
- admin_options_settings_export() : mixed
- register export option on options_settings_page
- check_last_operation() : mixed
- check last operation(s)
- clear_all_caches() : mixed
- Kinsta clear all (site & edge) caches
- form_download_sites() : void
- Kinsta download sites/environments
- form_validate_apikey() : string|bool
- Kinsta get company from api key (validate kinsta_api_key)
- initialize() : mixed
- initialize method - called from main plugin
- kinsta_api_actions() : mixed
- add actions for cache methods and alternate logging
- kinsta_api_check_operation() : array<string|int, mixed>
- get the status information of last operation(s)
- kinsta_api_clear_cdn_cache() : object|bool
- clear cdn cache
- kinsta_api_clear_edge_cache() : object|bool
- clear edge cache
- kinsta_api_clear_site_cache() : object|bool
- clear site cache
- kinsta_api_data() : object
- get api sites/environments json data
- kinsta_api_get_company_sites() : object|bool
- get list of company sites
- kinsta_api_get_company_users() : object|bool
- get list of company users
- kinsta_api_get_selected_environment() : object|bool
- get selected environment
- kinsta_api_get_selected_site() : object|bool
- get site by id
- kinsta_api_get_site_environments() : object|bool
- get site environments
- kinsta_api_local_request() : object
- local api request
- kinsta_api_remote_request() : object
- remote api request
- kinsta_api_restart_php() : object|bool
- restart php
- kinsta_api_return_result() : object|bool
- Kinsta return result
- kinsta_api_validate_key() : object|bool
- validate api key (get company id)
- kinsta_download_data() : void
- download api sites/environments json data
Constants
KINSTA_LOCAL
public
bool
KINSTA_LOCAL
= true
use local (true) or remote (false) endpoint for site & cdn cache api. local endpoint is the same as the offcial Kinsta plugin and offers no operation check, remote uses the documented api and provides operation_id for follow-up check. edge-cache has no local endpoint.
VERSION
public
string
VERSION
= '25.0527.1'
extension version
Methods
__construct()
constructor method
public
__construct(object $plugin) : mixed
Parameters
- $plugin : object
-
main plugin object
Return values
mixed —addActionsAndFilters()
Add filters and actions - called from main plugin
public
addActionsAndFilters() : mixed
Return values
mixed —admin_options_settings()
register options on options_settings_page
public
admin_options_settings() : mixed
Return values
mixed —admin_options_settings_export()
register export option on options_settings_page
public
admin_options_settings_export() : mixed
Return values
mixed —check_last_operation()
check last operation(s)
public
check_last_operation([string $operation = null ][, mixed $operation_id = null ][, mixed $operation_time = null ]) : mixed
Parameters
- $operation : string = null
-
the kinsta operation id
- $operation_id : mixed = null
- $operation_time : mixed = null
Return values
mixed —clear_all_caches()
Kinsta clear all (site & edge) caches
public
clear_all_caches([array<string|int, mixed> $caches = [] ]) : mixed
Parameters
- $caches : array<string|int, mixed> = []
-
- may pass cache name(s) cleared
Return values
mixed —form_download_sites()
Kinsta download sites/environments
public
form_download_sites() : void
Return values
void —form_validate_apikey()
Kinsta get company from api key (validate kinsta_api_key)
public
form_validate_apikey([mixed $api_key = null ][, mixed $field = '' ][, mixed $meta = [] ][, mixed $prior = '' ]) : string|bool
Parameters
- $api_key : mixed = null
- $field : mixed = ''
- $meta : mixed = []
- $prior : mixed = ''
Return values
string|bool —initialize()
initialize method - called from main plugin
public
initialize() : mixed
Return values
mixed —kinsta_api_actions()
add actions for cache methods and alternate logging
public
kinsta_api_actions() : mixed
Return values
mixed —kinsta_api_check_operation()
get the status information of last operation(s)
public
kinsta_api_check_operation([string $operation = null ][, string $operation_id = null ][, mixed $operation_time = null ]) : array<string|int, mixed>
Parameters
- $operation : string = null
-
the operation (function) name (optional, use transient)
- $operation_id : string = null
-
the kinsta operation id (optional, use transient)
- $operation_time : mixed = null
Return values
array<string|int, mixed> —[ operation_id => {name, title, status, message, data} ]
kinsta_api_clear_cdn_cache()
clear cdn cache
public
kinsta_api_clear_cdn_cache([string $environment_id = null ]) : object|bool
Parameters
- $environment_id : string = null
-
(optional if $this->environment_id is set)
Return values
object|bool —api result or false
kinsta_api_clear_edge_cache()
clear edge cache
public
kinsta_api_clear_edge_cache([string $environment_id = null ]) : object|bool
Parameters
- $environment_id : string = null
-
(optional if $this->environment_id is set)
Return values
object|bool —api result or false
kinsta_api_clear_site_cache()
clear site cache
public
kinsta_api_clear_site_cache([string $environment_id = null ]) : object|bool
Parameters
- $environment_id : string = null
-
(optional if $this->environment_id is set)
Return values
object|bool —api result or false
kinsta_api_data()
get api sites/environments json data
public
kinsta_api_data() : object
Return values
object —kinsta_api_get_company_sites()
get list of company sites
public
kinsta_api_get_company_sites([string $company_id = null ]) : object|bool
Parameters
- $company_id : string = null
-
(optional if $this->company_id is set)
Return values
object|bool —sites: [id,name,display_name,status,site_labels] }
kinsta_api_get_company_users()
get list of company users
public
kinsta_api_get_company_users([string $company_id = null ]) : object|bool
Parameters
- $company_id : string = null
-
(optional if $this->company_id is set)
Return values
object|bool —[user: {id,email,image,full_name}]
kinsta_api_get_selected_environment()
get selected environment
public
kinsta_api_get_selected_environment([string $environment_id = null ][, string $site_id = null ]) : object|bool
Parameters
- $environment_id : string = null
-
(optional if $this->environment_id is set)
- $site_id : string = null
-
(optional if $this->site_id is set)
Return values
object|bool —kinsta_api_get_selected_site()
get site by id
public
kinsta_api_get_selected_site([string $site_id = null ]) : object|bool
Parameters
- $site_id : string = null
-
(optional if $this->site_id is set)
Return values
object|bool —kinsta_api_get_site_environments()
get site environments
public
kinsta_api_get_site_environments([string $site_id = null ]) : object|bool
Parameters
- $site_id : string = null
-
(optional if $this->site_id is set)
Return values
object|bool —kinsta_api_local_request()
local api request
public
kinsta_api_local_request(string $method, string $endpoint) : object
Parameters
- $method : string
-
get|post
- $endpoint : string
-
uri
Return values
object —kinsta_api_remote_request()
remote api request
public
kinsta_api_remote_request(string $method, string $endpoint[, array<string|int, mixed> $payload = null ][, bool|int $cache = true ]) : object
Parameters
- $method : string
-
get|post
- $endpoint : string
-
uri
- $payload : array<string|int, mixed> = null
-
[key=>value,...]
- $cache : bool|int = true
-
enable caching|ttl
Return values
object —kinsta_api_restart_php()
restart php
public
kinsta_api_restart_php([string $environment_id = null ]) : object|bool
Parameters
- $environment_id : string = null
-
(optional if $this->environment_id is set)
Return values
object|bool —api result or false
kinsta_api_return_result()
Kinsta return result
public
kinsta_api_return_result(object $result[, string|bool $operation = false ]) : object|bool
Parameters
- $result : object
-
from api call
- $operation : string|bool = false
-
log/display message operation (FUNCTION | false)
Return values
object|bool —api result or false
kinsta_api_validate_key()
validate api key (get company id)
public
kinsta_api_validate_key([string $api_key = null ]) : object|bool
Parameters
- $api_key : string = null
-
(optional if $this->api_key is set)
Return values
object|bool —{name,expires_at,company,status}
kinsta_download_data()
download api sites/environments json data
public
kinsta_download_data() : void