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.
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.
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.
Settings
Class to initialise all defined page layouts.

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.

Constants

PLUGIN_VERSION

The plugin version.

public mixed PLUGIN_VERSION = '2.8.0d'
Tags
link

Versioning Guide

since
2.1.4
todo

Draw from envfile rather than hard-coding.

global

string PLUGIN_VERSION The version of this instance of the plugin.

PRODUCTION_ENV

The environment that the plugin is configured for.

public mixed PRODUCTION_ENV = false

This primarily affects whether minified or unminified CSS/JS files are requested.

Tags
since
2.5.5
todo

Draw from envfile rather than hard-coding.

todo

Replace with string for >2 environment options.

global

bool PRODUCTION_ENV Whether the plugin is running in production mode or not.

Functions

activate_footnotes()

Handles the activation of the plugin.

activate_footnotes() : void
Tags
since
2.8.0
see
Activator::activate()
Return values
void

run_footnotes()

Begins execution of the plugin.

run_footnotes() : void

Since everything within the plugin is registered via hooks, then kicking off the plugin from this point in the file does not affect the page life cycle. This takes place after the plugins_loaded hook, so that other Plugins may filter options.

Tags
since
2.8.0
Return values
void

Search results