Cp_Plgn_Drctry_Activator
in package
Fired during plugin activation.
Description
This class defines all code necessary to run during the plugin's activation. It provides a solid security check, after which you can safely perform any actication action.
Tags
Table of Contents
- $plugin : string
- The $_REQUEST['plugin'] during plugin activation.
- $request : array<string|int, string>
- The $_REQUEST during plugin activation.
- activate() : void
- Activate the plugin.
- check_caps() : bool
- Check Capabilities.
- get_request() : bool|array<string|int, mixed>
- Get the request.
- validate_request() : bool
- Validate the Request data.
Properties
$plugin
The $_REQUEST['plugin'] during plugin activation.
private
static string
$plugin
= \CP_PLGN_DRCTRY_BASE_NAME
Description
The $_REQUEST['plugin'] value during plugin activation.
Tags
$request
The $_REQUEST during plugin activation.
private
static array<string|int, string>
$request
= array()
Description
The $_REQUEST array during plugin activation.
Tags
Methods
activate()
Activate the plugin.
public
static activate() : void
Description
Checks if the plugin was (safely) activated. Place to add any custom action during plugin activation.
Tags
Return
(void)check_caps()
Check Capabilities.
private
static check_caps() : bool
Description
We want no one else but users with activate_plugins or above to be able to active this plugin.
Tags
Return
(bool) False if no caps, else true.get_request()
Get the request.
private
static get_request() : bool|array<string|int, mixed>
Description
Gets the $_REQUEST array and checks if necessary keys are set. Populates self::request with necessary and sanitized values.
Tags
Return
(bool |array<string|int, mixed>) $request False or self::$request array.validate_request()
Validate the Request data.
private
static validate_request(string $plugin) : bool
Description
Validates the $_REQUESTed data is matching this plugin and action.
Parameters
- $plugin
- (string) The Plugin folder/name.php.