Documentation

footnotes

Packages

includes

Interfaces, Classes and Traits

Admin

Class provide all admin-specific functionality of the plugin.

WYSIWYG

Class providing WYSIWYG editor intergration for the plugin.

Engine

Class to be extended by page layout sub-classes.

Init

Class to initialise all defined page layouts.

SettingsPage

Class to initialise all defined page layouts.

Activator

Class providing action(s) on plugin activation.

Config

Class defining plugin constants.

Convert

Class providing variable type and value conversion functions.

Core

Class providing core plugin functionality.

Deactivator

Class providing action(s) on plugin deactivation.

i18n

Class providing internationalization functionality.

Loader

Class defining action/filter registration for the plugin.

Settings

Class defining configurable plugin settings.

Setting

Class defining a configurable plugin setting.

General

Class provide all public-facing functionality of the plugin.

Parser

Searches and replaces the footnotes and generates the reference container.

Base

Base class to be extended by all widget sub-classes.

Reference_Container

Registers a Widget to put the Reference Container to the widget area.

SettingsGroup

Class defining a group of plugin settings within a section.

SettingsSection

Abstract class defining a section of plugin settings.

CustomCSSSettingsGroup

Class defining the custom CSS settings.

CustomCSSSettingsSection

Class defining plugin referrer and tooltips settings.

AMPCompatSettingsGroup

Class defining the AMP compat. settings.

ExcerptsSettingsGroup

Class defining the footnote exerpts settings.

GeneralSettingsSection

Class defining general plugin settings.

HardLinksSettingsGroup

Class defining the hard links settings.

LoveSettingsGroup

Class defining the footnote love settings.

NumberingSettingsGroup

Class defining the footnote numbering settings.

ReferenceContainerSettingsGroup

Class defining the reference container settings.

ScrollingSettingsGroup

Class defining the scrolling settings.

ShortcodeSettingsGroup

Class defining the footnote shortcode delimiter settings.

BacklinkSymbolSettingsGroup

Class defining the backlink symbol settings.

ReferrersAndTooltipsSettingsSection

Class defining plugin referrer and tooltips settings.

ReferrersInLabelsSettingsGroup

Class defining the referrer in labels settings.

ReferrersSettingsGroup

Class defining the referrer settings.

TooltipAppearanceSettingsGroup

Class defining the tooltip appearance settings.

TooltipDimensionsSettingsGroup

Class defining the tooltip dimension settings.

TooltipPositionSettingsGroup

Class defining the tooltip position settings.

TooltipsSettingsGroup

Class defining the tooltip settings.

TooltipTextSettingsGroup

Class defining the tooltip position settings.

TooltipTimingSettingsGroup

Class defining the tooltip timing settings.

TooltipTruncationSettingsGroup

Class defining the tooltip truncation settings.

ScopeAndPrioritySettingsSection

Class defining plugin hook priority settings.

WordPressHooksSettingsGroup

Class defining the WordPress hook settings.

Table of Contents

PLUGIN_VERSION  = '2.8.0d'

The plugin version.

PRODUCTION_ENV  = false

The environment that the plugin is configured for.

activate_footnotes()  : void

Handles the activation of the plugin.

deactivate_footnotes()  : void

Handles the deactivation of the plugin.

run_footnotes()  : void

Begins execution of the plugin.