Documentation

Init
in package

Class to initialise all defined page layouts.

Tags
since
1.5.0

Table of Contents

MAIN_MENU_SLUG  = 'footnotes'
Slug for the Plugin main menu.
$plugin_name  : string
The ID of this plugin.
$settings  : Settings
The plugin settings object.
$settings_page  : SettingsPage
Contains the settings page.
__construct()  : mixed
Initializes all WordPress hooks for the Plugin Settings.
get_plugin_meta_information()  : void
AJAX call. returns a JSON string containing meta information about a specific WordPress Plugin.
initialize_settings()  : void
Registers the settings and initialises the settings page.
register_options_submenu()  : void
Registers the footnotes submenu page.
load_dependencies()  : void
Load the required dependencies for the layouts pages.

Constants

MAIN_MENU_SLUG

Slug for the Plugin main menu.

public string MAIN_MENU_SLUG = 'footnotes'
Tags
since
1.5.0

Properties

$plugin_name

The ID of this plugin.

private string $plugin_name

The ID of this plugin.

Tags
access

private

since
2.8.0

$settings

The plugin settings object.

private Settings $settings
Tags
access

private

since
2.8.0

Methods

__construct()

Initializes all WordPress hooks for the Plugin Settings.

public __construct(string $plugin_name, Settings $settings) : mixed
Parameters
$plugin_name : string
$settings : Settings
Tags
since
1.5.0
since
2.8.0

Added $plugin_name parameter.

Return values
mixed

get_plugin_meta_information()

AJAX call. returns a JSON string containing meta information about a specific WordPress Plugin.

public get_plugin_meta_information() : void
Tags
since
1.5.0
Return values
void

initialize_settings()

Registers the settings and initialises the settings page.

public initialize_settings() : void
Tags
since
1.5.0
Return values
void

load_dependencies()

Load the required dependencies for the layouts pages.

private load_dependencies() : void

Include the following files that make up the plugin:

  • Config: defines plugin constants;
  • Settings: defines configurable plugin settings; and
  • Settings: defines the plugin settings page.
Tags
access

private

since
2.8.0
Return values
void

Search results