PluginsHelper
in package
Class PluginsHelper
Table of Contents
- activate_plugins() : WP_Error|array<string|int, mixed>
- Activate the requested plugins.
- get_action_data() : array<string|int, mixed>
- Gets the plugin data for the first action.
- get_activation_status() : array<string|int, mixed>
- Activation status.
- get_active_plugin_slugs() : array<string|int, mixed>
- Get an array of active plugin slugs.
- get_installation_status() : array<string|int, mixed>
- Installation status.
- get_installed_plugin_slugs() : array<string|int, mixed>
- Get an array of installed plugin slugs.
- get_installed_plugins_paths() : array<string|int, mixed>
- Get an array of installed plugins with their file paths as a key value pair.
- get_plugin_data() : array<string|int, mixed>|false
- Get plugin data.
- get_plugin_path_from_slug() : string|false
- Get the path to the plugin file relative to the plugins directory from the plugin slug.
- init() : mixed
- Initialize hooks.
- install_and_activate_plugins_async_callback() : bool
- Callback regsitered by OnboardingPlugins::install_and_activate_async.
- install_plugins() : array<string|int, mixed>
- Install an array of plugins.
- is_plugin_active() : bool
- Checks if a plugin is active.
- is_plugin_installed() : bool
- Checks if a plugin is installed.
- schedule_activate_plugins() : string
- Schedule plugin activation.
- schedule_install_plugins() : string
- Schedule plugin installation.
Methods
activate_plugins()
Activate the requested plugins.
public
static activate_plugins(array<string|int, mixed> $plugins[, PluginsInstallLogger|null $logger = null ]) : WP_Error|array<string|int, mixed>
Parameters
- $plugins : array<string|int, mixed>
-
Plugins.
- $logger : PluginsInstallLogger|null = null
-
Logger.
Return values
WP_Error|array<string|int, mixed> — Plugin Statusget_action_data()
Gets the plugin data for the first action.
public
static get_action_data(array<string|int, mixed> $actions) : array<string|int, mixed>
Parameters
- $actions : array<string|int, mixed>
-
Array of AS actions.
Return values
array<string|int, mixed> — Array of action data.get_activation_status()
Activation status.
public
static get_activation_status([int $job_id = null ]) : array<string|int, mixed>
Parameters
- $job_id : int = null
-
Job ID.
Return values
array<string|int, mixed> — Array of action data.get_active_plugin_slugs()
Get an array of active plugin slugs.
public
static get_active_plugin_slugs() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_installation_status()
Installation status.
public
static get_installation_status([int $job_id = null ]) : array<string|int, mixed>
Parameters
- $job_id : int = null
-
Job ID.
Return values
array<string|int, mixed> — Job data.get_installed_plugin_slugs()
Get an array of installed plugin slugs.
public
static get_installed_plugin_slugs() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_installed_plugins_paths()
Get an array of installed plugins with their file paths as a key value pair.
public
static get_installed_plugins_paths() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_plugin_data()
Get plugin data.
public
static get_plugin_data(string $plugin) : array<string|int, mixed>|false
Parameters
- $plugin : string
-
Path to the plugin file relative to the plugins directory or the plugin directory name.
Return values
array<string|int, mixed>|false —get_plugin_path_from_slug()
Get the path to the plugin file relative to the plugins directory from the plugin slug.
public
static get_plugin_path_from_slug(string $slug) : string|false
E.g. 'woocommerce' returns 'woocommerce/woocommerce.php'
Parameters
- $slug : string
-
Plugin slug to get path for.
Return values
string|false —init()
Initialize hooks.
public
static init() : mixed
Return values
mixed —install_and_activate_plugins_async_callback()
Callback regsitered by OnboardingPlugins::install_and_activate_async.
public
static install_and_activate_plugins_async_callback(array<string|int, mixed> $plugins, string $job_id) : bool
It is used to call install_plugins and activate_plugins with a custom logger.
Parameters
- $plugins : array<string|int, mixed>
-
A list of plugins to install.
- $job_id : string
-
An unique job I.D.
Return values
bool —install_plugins()
Install an array of plugins.
public
static install_plugins(array<string|int, mixed> $plugins[, PluginsInstallLogger|null $logger = null ]) : array<string|int, mixed>
Parameters
- $plugins : array<string|int, mixed>
-
Plugins to install.
- $logger : PluginsInstallLogger|null = null
-
an optional logger.
Return values
array<string|int, mixed> —is_plugin_active()
Checks if a plugin is active.
public
static is_plugin_active(string $plugin) : bool
Parameters
- $plugin : string
-
Path to the plugin file relative to the plugins directory or the plugin directory name.
Return values
bool —is_plugin_installed()
Checks if a plugin is installed.
public
static is_plugin_installed(string $plugin) : bool
Parameters
- $plugin : string
-
Path to the plugin file relative to the plugins directory or the plugin directory name.
Return values
bool —schedule_activate_plugins()
Schedule plugin activation.
public
static schedule_activate_plugins(array<string|int, mixed> $plugins) : string
Parameters
- $plugins : array<string|int, mixed>
-
Plugins to activate.
Return values
string — Job ID.schedule_install_plugins()
Schedule plugin installation.
public
static schedule_install_plugins(array<string|int, mixed> $plugins) : string
Parameters
- $plugins : array<string|int, mixed>
-
Plugins to install.