Core
in package
Class providing core plugin functionality.
This is used to define internationalization, admin-specific hooks, and public-facing site hooks.
Tags
Table of Contents
- $settings : Settings
- The plugin settings object.
- $loader : Loader
- The loader that's responsible for maintaining and registering all hooks that power the plugin.
- $plugin_name : string
- The unique identifier of this plugin
- $version : string
- The current version of the plugin.
- __construct() : void
- Builds the core of the plugin.
- get_loader() : Loader
- Returns a reference to the class that orchestrates the hooks with the plugin.
- get_plugin_name() : string
- Gets the name of the plugin used to uniquely identify it within the context of WordPress and to define internationalization functionality.
- get_version() : string
- Gets the version number of the plugin.
- run() : void
- Runs the loader to execute all of the hooks with WordPress.
- define_admin_hooks() : void
- Register all of the hooks related to the admin area functionality of the plugin.
- define_public_hooks() : void
- Register all of the hooks related to the public-facing functionality of the plugin.
- load_dependencies() : void
- Load the required dependencies for this plugin.
- set_locale() : void
- Define the locale for this plugin for internationalization.
Properties
$settings
The plugin settings object.
public
Settings
$settings
Tags
$loader
The loader that's responsible for maintaining and registering all hooks that power the plugin.
protected
Loader
$loader
Maintains and registers all hooks for the plugin.
Tags
$plugin_name
The unique identifier of this plugin
protected
string
$plugin_name
The string used to uniquely identify this plugin.
Tags
$version
The current version of the plugin.
protected
string
$version
The current version of the plugin.
Tags
Methods
__construct()
Builds the core of the plugin.
public
__construct() : void
Set the plugin name and the plugin version that can be used throughout the plugin. Load the dependencies, define the locale, and set the hooks for the admin area and the public-facing side of the site.
Tags
Return values
void —get_loader()
Returns a reference to the class that orchestrates the hooks with the plugin.
public
get_loader() : Loader
Tags
Return values
Loader —get_plugin_name()
Gets the name of the plugin used to uniquely identify it within the context of WordPress and to define internationalization functionality.
public
get_plugin_name([bool $html = false ]) : string
Parameters
- $html : bool = false
Tags
Return values
string —get_version()
Gets the version number of the plugin.
public
get_version() : string
Tags
Return values
string —run()
Runs the loader to execute all of the hooks with WordPress.
public
run() : void
Tags
Return values
void —define_admin_hooks()
Register all of the hooks related to the admin area functionality of the plugin.
private
define_admin_hooks() : void
Tags
Return values
void —define_public_hooks()
Register all of the hooks related to the public-facing functionality of the plugin.
private
define_public_hooks() : void
Tags
Return values
void —load_dependencies()
Load the required dependencies for this plugin.
private
load_dependencies() : void
Includes the following files that make up the plugin:
- Loader: orchestrates the hooks of the plugin;
- i18n: defines internationalization functionality;
- Config: defines plugin details;
- Convert: provides conversion methods;
- Settings: defines customisable plugin settings;
- Template: handles template rendering;
- Admin: defines all hooks for the admin area; and
- General: defines all hooks for the public side of the site.
Creates an instance of the loader which will be used to register the hooks with WordPress.
Tags
Return values
void —set_locale()
Define the locale for this plugin for internationalization.
private
set_locale() : void
Uses i18n in order to set the domain and to register the hook with WordPress.