Documentation

Footnotes_Public

The public-facing functionality of the plugin.

Defines the plugin name, version, and enqueues all public-facing stylesheets and JavaScript.

Tags
subpackage

footnotes/public

Table of Contents

$a_bool_alternative_tooltips_enabled  : bool
Allows to determine whether alternative tooltips are enabled.
$a_bool_amp_enabled  : bool
Allows to determine whether AMP compatibility mode is enabled.
$a_bool_tooltips_enabled  : bool
Flag for using tooltips.
$a_obj_task  : Footnote_Parser
The footnote parser.
$a_str_script_mode  : str
Allows to determine the script mode among jQuery or plain JS.
$plugin_name  : string
The ID of this plugin.
$reference_container_widget  : Footnotes_Widget_Reference_Container
The reference container widget.
$version  : string
The version of this plugin.
__construct()  : mixed
Initialize the class and set its properties.
enqueue_scripts()  : mixed
Register the JavaScript for the public-facing side of the site.
enqueue_styles()  : mixed
Register the stylesheets for the public-facing side of the site.
register_widgets()  : mixed
Register the widget(s) for the public-facing side of the site.
load_dependencies()  : mixed
Load the required public-facing dependencies.

Properties

$a_bool_alternative_tooltips_enabled

Allows to determine whether alternative tooltips are enabled.

public static bool $a_bool_alternative_tooltips_enabled = alse
Tags
since
2.1.1
since
2.8.0

Moved from Footnotes to Footnotes_Public class.

$a_bool_amp_enabled

Allows to determine whether AMP compatibility mode is enabled.

public static bool $a_bool_amp_enabled = alse
Tags
since
2.6.0

(release)

since
2.8.0

Moved from Footnotes to Footnotes_Public class.

$a_bool_tooltips_enabled

Flag for using tooltips.

public static bool $a_bool_tooltips_enabled = alse
Tags
since
2.4.0
since
2.8.0

Moved from Footnotes to Footnotes_Public class.

$a_obj_task

The footnote parser.

public Footnote_Parser $a_obj_task = ull
Tags
since
1.5.0
since
2.8.0

Moved from Footnotes to Footnotes_Public class.

$a_str_script_mode

Allows to determine the script mode among jQuery or plain JS.

public static str $a_str_script_mode = 'js'
Tags
since
2.5.6
since
2.8.0

Moved from Footnotes to Footnotes_Public class.

Methods

__construct()

Initialize the class and set its properties.

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

The name of this plugin.

$version : string

The version of this plugin.

Tags
since
2.8.0
Return values
mixed

enqueue_scripts()

Register the JavaScript for the public-facing side of the site.

public enqueue_scripts() : mixed
Tags
since
1.5.0
since
2.0.0

Add jQueryUI dependency.

since
2.1.2

Add jQuery Tools dependency.

since
2.5.6

Add jQuery dependency.

since
2.8.0

Moved from Footnotes to Footnotes_Public class.

Return values
mixed

enqueue_styles()

Register the stylesheets for the public-facing side of the site.

public enqueue_styles() : mixed

Enables enqueuing the formatted individual stylesheets if PRODCUTION_ENV is true (set in footnotes.php).

Tags
since
1.5.0
since
2.5.5

Change stylesheet scheme.

since
2.8.0

Moved from Footnotes to Footnotes_Public class.

Return values
mixed

register_widgets()

Register the widget(s) for the public-facing side of the site.

public register_widgets() : mixed
Tags
since
1.5.0
since
2.8.0

Moved to Footnotes_Public class.

Return values
mixed

load_dependencies()

Load the required public-facing dependencies.

private load_dependencies() : mixed

Include the following files that provide the public-facing functionality of this plugin:

  • Footnotes_Parser. Parses Posts and Pages for footnote shortcodes.
  • Footnotes_Widget_Reference_Container. Defines the Reference Container widget.
Tags
since
2.8.0
access

private

Return values
mixed

Search results