Footnotes
in package
The core plugin class.
This is used to define internationalization, admin-specific hooks, and public-facing site hooks.
Also maintains the unique identifier of this plugin as well as the current version of the plugin.
Tags
Table of Contents
- $loader : Footnotes_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() : mixed
- Define the core functionality of the plugin.
- get_loader() : Footnotes_Loader
- The reference to the class that orchestrates the hooks with the plugin.
- get_plugin_name() : string
- The name of the plugin used to uniquely identify it within the context of WordPress and to define internationalization functionality.
- get_version() : string
- Retrieve the version number of the plugin.
- run() : mixed
- Run the loader to execute all of the hooks with WordPress.
- define_admin_hooks() : mixed
- Register all of the hooks related to the admin area functionality of the plugin.
- define_public_hooks() : mixed
- Register all of the hooks related to the public-facing functionality of the plugin.
- load_dependencies() : mixed
- Load the required dependencies for this plugin.
- set_locale() : mixed
- Define the locale for this plugin for internationalization.
Properties
$loader
The loader that's responsible for maintaining and registering all hooks that power the plugin.
protected
Footnotes_Loader
$loader
Tags
$plugin_name
The unique identifier of this plugin
protected
string
$plugin_name
Tags
$version
The current version of the plugin.
protected
string
$version
Tags
Methods
__construct()
Define the core functionality of the plugin.
public
__construct() : mixed
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
mixed —get_loader()
The reference to the class that orchestrates the hooks with the plugin.
public
get_loader() : Footnotes_Loader
Tags
Return values
Footnotes_Loader —Orchestrates the hooks of the plugin.
get_plugin_name()
The name of the plugin used to uniquely identify it within the context of WordPress and to define internationalization functionality.
public
get_plugin_name() : string
Tags
Return values
string —The name of the plugin.
get_version()
Retrieve the version number of the plugin.
public
get_version() : string
Tags
Return values
string —The version number of the plugin.
run()
Run the loader to execute all of the hooks with WordPress.
public
run() : mixed
Tags
Return values
mixed —define_admin_hooks()
Register all of the hooks related to the admin area functionality of the plugin.
private
define_admin_hooks() : mixed
Tags
Return values
mixed —define_public_hooks()
Register all of the hooks related to the public-facing functionality of the plugin.
private
define_public_hooks() : mixed
Tags
Return values
mixed —load_dependencies()
Load the required dependencies for this plugin.
private
load_dependencies() : mixed
Include the following files that make up the plugin:
-
Footnotes_Loader. Orchestrates the hooks of the plugin. -
Footnotes_i18n. Defines internationalization functionality. -
Footnotes_Config. Defines plugin details. -
Footnotes_Convert. Provides conversion methods. -
Footnotes_Settings. Defines customisable plugin settings. -
Footnotes_Template. Handles template rendering. -
Footnotes_Admin. Defines all hooks for the admin area. -
Footnotes_Public. Defines all hooks for the public side of the site.
Create an instance of the loader which will be used to register the hooks with WordPress.
Tags
Return values
mixed —set_locale()
Define the locale for this plugin for internationalization.
private
set_locale() : mixed
Uses the Footnotes_i18n class in order to set the domain and to register the hook
with WordPress.