Admin
in package
Class provide all admin-specific functionality of the plugin.
Defines the plugin name, version, and enqueues all admin-specific stylesheets and JavaScript.
Tags
Table of Contents
- $wysiwyg : WYSIWYG
- The WYSIWYG editor integration object.
- $plugin_name : string
- The ID of this plugin.
- $settings : Settings
- The plugin settings object.
- $version : string
- The version of this plugin.
- __construct() : mixed
- Initialize the class and set its properties.
- action_links() : array<string|int, string>
- Appends the Plugin links for display in the dashboard Plugins page.
- enqueue_scripts() : void
- Register the JavaScript for the admin area.
- enqueue_styles() : void
- Register the stylesheets for the admin area.
- load_dependencies() : void
- Load the required admin-specific dependencies.
Properties
$wysiwyg
The WYSIWYG editor integration object.
public
WYSIWYG
$wysiwyg
The WYSIWYG editor integration object.
Tags
$plugin_name
The ID of this plugin.
private
string
$plugin_name
Tags
$settings
The plugin settings object.
private
Settings
$settings
Tags
$version
The version of this plugin.
private
string
$version
Tags
Methods
__construct()
Initialize the class and set its properties.
public
__construct(string $plugin_name, string $version, Settings $settings) : mixed
Parameters
- $plugin_name : string
- $version : string
- $settings : Settings
Tags
Return values
mixed —action_links()
Appends the Plugin links for display in the dashboard Plugins page.
public
action_links(array<string|int, string> $plugin_links) : array<string|int, string>
Parameters
- $plugin_links : array<string|int, string>
-
The default set of links to display.
Tags
Return values
array<string|int, string> —The full set of links to display.
enqueue_scripts()
Register the JavaScript for the admin area.
public
enqueue_scripts() : void
Tags
Return values
void —enqueue_styles()
Register the stylesheets for the admin area.
public
enqueue_styles() : void
Tags
Return values
void —load_dependencies()
Load the required admin-specific dependencies.
private
load_dependencies() : void
Includes the following files that provide the admin-specific functionality of this plugin:
- WYSIWYG: Provides plugin integration with the WYSIWYG editor.
- Settings: Defines the plugin dashboard page(s).