Documentation

Init

Class to initialise all defined page layouts.

Tags
since
1.5.0

Table of Contents

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

Constants

C_STR_MAIN_MENU_SLUG

Slug for the Plugin main menu.

public string C_STR_MAIN_MENU_SLUG = 'footnotes'
Tags
since
1.5.0

Properties

$plugin_name

The ID of this plugin.

private string $plugin_name
Tags
access

private

since
2.8.0

$settings_page

Contains the settings page.

private Settings $settings_page
Tags
since
1.5.0

Methods

__construct()

Initializes all WordPress hooks for the Plugin Settings.

public __construct(string $plugin_name) : mixed
Parameters
$plugin_name : string

The name of the plugin.

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() : mixed
Tags
since
1.5.0
Return values
mixed

initialize_settings()

Registers the settings and initialises the settings page.

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

load_dependencies()

Load the required dependencies for the layouts pages.

private load_dependencies() : mixed

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
mixed

Search results