<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Documentation</title> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <base href="../"> <link rel="icon" href="images/favicon.ico"/> <link rel="stylesheet" href="css/normalize.css"> <link rel="stylesheet" href="css/base.css"> <link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet"> <link rel="stylesheet" href="css/template.css"> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" /> <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script> <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/js/all.min.js" integrity="sha256-0vuk8LXoyrmCjp1f0O300qo1M75ZQyhH9X3J6d+scmk=" crossorigin="anonymous"></script> <script src="js/search.js"></script> <script defer src="js/searchIndex.js"></script> </head> <body id="top"> <header class="phpdocumentor-header phpdocumentor-section"> <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1> <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" /> <label class="phpdocumentor-header__menu-icon" for="menu-button"> <i class="fas fa-bars"></i> </label> <section data-search-form class="phpdocumentor-search"> <label> <span class="visually-hidden">Search for</span> <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg"> <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/> <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/> </svg> <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled /> </label> </section> <nav class="phpdocumentor-topnav"> <ul class="phpdocumentor-topnav__menu"> </ul> </nav> </header> <main class="phpdocumentor"> <div class="phpdocumentor-section"> <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" /> <label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button"> Menu </label> <aside class="phpdocumentor-column -four phpdocumentor-sidebar"> <section class="phpdocumentor-sidebar__category"> <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2> <h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h4> <ul class="phpdocumentor-list"> <li><a href="namespaces/footnotes-admin.html"><abbr title="\footnotes\admin">admin</abbr></a></li> <li><a href="namespaces/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li> <li><a href="namespaces/footnotes-general.html"><abbr title="\footnotes\general">general</abbr></a></li> </ul> </section> <section class="phpdocumentor-sidebar__category"> <h2 class="phpdocumentor-sidebar__category-header">Reports</h2> <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3> <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3> <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3> </section> <section class="phpdocumentor-sidebar__category"> <h2 class="phpdocumentor-sidebar__category-header">Indices</h2> <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3> </section> </aside> <div class="phpdocumentor-column -eight phpdocumentor-content"> <ul class="phpdocumentor-breadcrumbs"> <li class="phpdocumentor-breadcrumb"><a href="namespaces/footnotes.html">footnotes</a></li> <li class="phpdocumentor-breadcrumb"><a href="namespaces/footnotes-general.html">general</a></li> </ul> <article class="phpdocumentor-element -class"> <h2 class="phpdocumentor-content__title"> General </h2> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="src/public/class-general.php"><a href="files/src-public-class-general.html"><abbr title="src/public/class-general.php">class-general.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">22</span> </aside> <p class="phpdocumentor-summary">Class provide all public-facing functionality of the plugin.</p> <section class="phpdocumentor-description"><p>Defines the plugin name, version, and enqueues all public-facing stylesheets and JavaScript.</p> </section> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">2.8.0</span> <section class="phpdocumentor-description"></section> </dd> </dl> <h3 id="toc"> Table of Contents <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a> </h3> <dl class="phpdocumentor-table-of-contents"> <dt class="phpdocumentor-table-of-contents__entry -property -public"> <a href="classes/footnotes-general-General.html#property_a_bool_alternative_tooltips_enabled">$a_bool_alternative_tooltips_enabled</a> <span> : bool </span> </dt> <dd>Allows to determine whether alternative tooltips are enabled.</dd> <dt class="phpdocumentor-table-of-contents__entry -property -public"> <a href="classes/footnotes-general-General.html#property_a_bool_amp_enabled">$a_bool_amp_enabled</a> <span> : bool </span> </dt> <dd>Allows to determine whether AMP compatibility mode is enabled.</dd> <dt class="phpdocumentor-table-of-contents__entry -property -public"> <a href="classes/footnotes-general-General.html#property_a_bool_tooltips_enabled">$a_bool_tooltips_enabled</a> <span> : bool </span> </dt> <dd>Flag for using tooltips.</dd> <dt class="phpdocumentor-table-of-contents__entry -property -public"> <a href="classes/footnotes-general-General.html#property_a_obj_task">$a_obj_task</a> <span> : <a href="classes/footnotes-general-Parser.html"><abbr title="\footnotes\general\Parser">Parser</abbr></a> </span> </dt> <dd>The footnote parser.</dd> <dt class="phpdocumentor-table-of-contents__entry -property -public"> <a href="classes/footnotes-general-General.html#property_a_str_script_mode">$a_str_script_mode</a> <span> : string </span> </dt> <dd>Allows to determine the script mode among jQuery or plain JS.</dd> <dt class="phpdocumentor-table-of-contents__entry -property -private"> <a href="classes/footnotes-general-General.html#property_plugin_name">$plugin_name</a> <span> : string </span> </dt> <dd>The ID of this plugin.</dd> <dt class="phpdocumentor-table-of-contents__entry -property -private"> <a href="classes/footnotes-general-General.html#property_reference_container_widget">$reference_container_widget</a> <span> : <a href="classes/footnotes-general-Widget-Reference-Container.html"><abbr title="\footnotes\general\Widget\Reference_Container">Reference_Container</abbr></a> </span> </dt> <dd>The reference container widget.</dd> <dt class="phpdocumentor-table-of-contents__entry -property -private"> <a href="classes/footnotes-general-General.html#property_version">$version</a> <span> : string </span> </dt> <dd>The version of this plugin.</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/footnotes-general-General.html#method___construct">__construct()</a> <span> : mixed </span> </dt> <dd>Initialize the class and set its properties.</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/footnotes-general-General.html#method_enqueue_scripts">enqueue_scripts()</a> <span> : mixed </span> </dt> <dd>Register the JavaScript for the public-facing side of the site.</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/footnotes-general-General.html#method_enqueue_styles">enqueue_styles()</a> <span> : mixed </span> </dt> <dd>Register the stylesheets for the public-facing side of the site.</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/footnotes-general-General.html#method_register_widgets">register_widgets()</a> <span> : mixed </span> </dt> <dd>Register the widget(s) for the public-facing side of the site.</dd> <dt class="phpdocumentor-table-of-contents__entry -method -private"> <a href="classes/footnotes-general-General.html#method_load_dependencies">load_dependencies()</a> <span> : mixed </span> </dt> <dd>Load the required public-facing dependencies.</dd> </dl> <section class="phpdocumentor-properties"> <h3 class="phpdocumentor-elements__header" id="properties"> Properties <a href="classes/footnotes-general-General.html#properties" class="headerlink"><i class="fas fa-link"></i></a> </h3> <article class=" phpdocumentor-element -property -public -static " > <h4 class="phpdocumentor-element__name" id="property_a_bool_alternative_tooltips_enabled"> $a_bool_alternative_tooltips_enabled <a href="classes/footnotes-general-General.html#property_a_bool_alternative_tooltips_enabled" class="headerlink"><i class="fas fa-link"></i></a> <span class="phpdocumentor-element__modifiers"> </span> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="src/public/class-general.php"><a href="files/src-public-class-general.html"><abbr title="src/public/class-general.php">class-general.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">81</span> </aside> <p class="phpdocumentor-summary">Allows to determine whether alternative tooltips are enabled.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">bool</span> <span class="phpdocumentor-signature__name">$a_bool_alternative_tooltips_enabled</span> = <span class="phpdocumentor-signature__default-value">false</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">2.1.1</span> <section class="phpdocumentor-description"></section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">2.8.0</span> <section class="phpdocumentor-description"><p>Moved from <abbr title="\footnotes\general\Footnotes">Footnotes</abbr> to <abbr title="\footnotes\includes\Public">Public</abbr>.</p> </section> </dd> </dl> </article> <article class=" phpdocumentor-element -property -public -static " > <h4 class="phpdocumentor-element__name" id="property_a_bool_amp_enabled"> $a_bool_amp_enabled <a href="classes/footnotes-general-General.html#property_a_bool_amp_enabled" class="headerlink"><i class="fas fa-link"></i></a> <span class="phpdocumentor-element__modifiers"> </span> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="src/public/class-general.php"><a href="files/src-public-class-general.html"><abbr title="src/public/class-general.php">class-general.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">91</span> </aside> <p class="phpdocumentor-summary">Allows to determine whether AMP compatibility mode is enabled.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">bool</span> <span class="phpdocumentor-signature__name">$a_bool_amp_enabled</span> = <span class="phpdocumentor-signature__default-value">false</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">2.6.0</span> <section class="phpdocumentor-description"></section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">2.8.0</span> <section class="phpdocumentor-description"><p>Moved from <abbr title="\footnotes\general\Footnotes">Footnotes</abbr> to <abbr title="\footnotes\includes\Public">Public</abbr>.</p> </section> </dd> </dl> </article> <article class=" phpdocumentor-element -property -public -static " > <h4 class="phpdocumentor-element__name" id="property_a_bool_tooltips_enabled"> $a_bool_tooltips_enabled <a href="classes/footnotes-general-General.html#property_a_bool_tooltips_enabled" class="headerlink"><i class="fas fa-link"></i></a> <span class="phpdocumentor-element__modifiers"> </span> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="src/public/class-general.php"><a href="files/src-public-class-general.html"><abbr title="src/public/class-general.php">class-general.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">71</span> </aside> <p class="phpdocumentor-summary">Flag for using tooltips.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">bool</span> <span class="phpdocumentor-signature__name">$a_bool_tooltips_enabled</span> = <span class="phpdocumentor-signature__default-value">false</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">2.4.0</span> <section class="phpdocumentor-description"></section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">2.8.0</span> <section class="phpdocumentor-description"><p>Moved from <abbr title="\footnotes\general\Footnotes">Footnotes</abbr> to <abbr title="\footnotes\includes\Public">Public</abbr>.</p> </section> </dd> </dl> </article> <article class=" phpdocumentor-element -property -public " > <h4 class="phpdocumentor-element__name" id="property_a_obj_task"> $a_obj_task <a href="classes/footnotes-general-General.html#property_a_obj_task" class="headerlink"><i class="fas fa-link"></i></a> <span class="phpdocumentor-element__modifiers"> </span> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="src/public/class-general.php"><a href="files/src-public-class-general.html"><abbr title="src/public/class-general.php">class-general.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">61</span> </aside> <p class="phpdocumentor-summary">The footnote parser.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__type"><a href="classes/footnotes-general-Parser.html"><abbr title="\footnotes\general\Parser">Parser</abbr></a></span> <span class="phpdocumentor-signature__name">$a_obj_task</span> = <span class="phpdocumentor-signature__default-value">null</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">1.5.0</span> <section class="phpdocumentor-description"></section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">2.8.0</span> <section class="phpdocumentor-description"><p>Moved from <abbr title="\footnotes\general\Footnotes">Footnotes</abbr> to <abbr title="\footnotes\includes\Public">Public</abbr>.</p> </section> </dd> </dl> </article> <article class=" phpdocumentor-element -property -public -static " > <h4 class="phpdocumentor-element__name" id="property_a_str_script_mode"> $a_str_script_mode <a href="classes/footnotes-general-General.html#property_a_str_script_mode" class="headerlink"><i class="fas fa-link"></i></a> <span class="phpdocumentor-element__modifiers"> </span> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="src/public/class-general.php"><a href="files/src-public-class-general.html"><abbr title="src/public/class-general.php">class-general.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">101</span> </aside> <p class="phpdocumentor-summary">Allows to determine the script mode among jQuery or plain JS.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">string</span> <span class="phpdocumentor-signature__name">$a_str_script_mode</span> = <span class="phpdocumentor-signature__default-value">'js'</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">2.5.6</span> <section class="phpdocumentor-description"></section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">2.8.0</span> <section class="phpdocumentor-description"><p>Moved from <abbr title="\footnotes\general\Footnotes">Footnotes</abbr> to <abbr title="\footnotes\includes\Public">Public</abbr>.</p> </section> </dd> </dl> </article> <article class=" phpdocumentor-element -property -private " > <h4 class="phpdocumentor-element__name" id="property_plugin_name"> $plugin_name <a href="classes/footnotes-general-General.html#property_plugin_name" class="headerlink"><i class="fas fa-link"></i></a> <span class="phpdocumentor-element__modifiers"> </span> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="src/public/class-general.php"><a href="files/src-public-class-general.html"><abbr title="src/public/class-general.php">class-general.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">32</span> </aside> <p class="phpdocumentor-summary">The ID of this plugin.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">private</span> <span class="phpdocumentor-signature__type">string</span> <span class="phpdocumentor-signature__name">$plugin_name</span> </code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">2.8.0</span> <section class="phpdocumentor-description"></section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">access</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>private</p> </section> </dd> </dl> </article> <article class=" phpdocumentor-element -property -private " > <h4 class="phpdocumentor-element__name" id="property_reference_container_widget"> $reference_container_widget <a href="classes/footnotes-general-General.html#property_reference_container_widget" class="headerlink"><i class="fas fa-link"></i></a> <span class="phpdocumentor-element__modifiers"> </span> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="src/public/class-general.php"><a href="files/src-public-class-general.html"><abbr title="src/public/class-general.php">class-general.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">51</span> </aside> <p class="phpdocumentor-summary">The reference container widget.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">private</span> <span class="phpdocumentor-signature__type"><a href="classes/footnotes-general-Widget-Reference-Container.html"><abbr title="\footnotes\general\Widget\Reference_Container">Reference_Container</abbr></a></span> <span class="phpdocumentor-signature__name">$reference_container_widget</span> </code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">2.8.0</span> <section class="phpdocumentor-description"></section> </dd> </dl> </article> <article class=" phpdocumentor-element -property -private " > <h4 class="phpdocumentor-element__name" id="property_version"> $version <a href="classes/footnotes-general-General.html#property_version" class="headerlink"><i class="fas fa-link"></i></a> <span class="phpdocumentor-element__modifiers"> </span> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="src/public/class-general.php"><a href="files/src-public-class-general.html"><abbr title="src/public/class-general.php">class-general.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">42</span> </aside> <p class="phpdocumentor-summary">The version of this plugin.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">private</span> <span class="phpdocumentor-signature__type">string</span> <span class="phpdocumentor-signature__name">$version</span> </code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">2.8.0</span> <section class="phpdocumentor-description"></section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">access</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>private</p> </section> </dd> </dl> </article> </section> <section class="phpdocumentor-methods"> <h3 class="phpdocumentor-elements__header" id="methods"> Methods <a href="classes/footnotes-general-General.html#methods" class="headerlink"><i class="fas fa-link"></i></a> </h3> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method___construct"> __construct() <a href="classes/footnotes-general-General.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="src/public/class-general.php"><a href="files/src-public-class-general.html"><abbr title="src/public/class-general.php">class-general.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">110</span> </aside> <p class="phpdocumentor-summary">Initialize the class and set its properties.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$plugin_name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$version</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$plugin_name</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>The name of this plugin.</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$version</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>The version of this plugin.</p> </section> </dd> </dl> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">2.8.0</span> <section class="phpdocumentor-description"></section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">mixed</span> — <section class="phpdocumentor-description"></section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_enqueue_scripts"> enqueue_scripts() <a href="classes/footnotes-general-General.html#method_enqueue_scripts" class="headerlink"><i class="fas fa-link"></i></a> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="src/public/class-general.php"><a href="files/src-public-class-general.html"><abbr title="src/public/class-general.php">class-general.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">224</span> </aside> <p class="phpdocumentor-summary">Register the JavaScript for the public-facing side of the site.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">enqueue_scripts</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">1.5.0</span> <section class="phpdocumentor-description"></section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">2.0.0</span> <section class="phpdocumentor-description"><p>Add jQueryUI dependency.</p> </section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">2.1.2</span> <section class="phpdocumentor-description"><p>Add jQuery Tools dependency.</p> </section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">2.5.6</span> <section class="phpdocumentor-description"><p>Add jQuery dependency.</p> </section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">2.8.0</span> <section class="phpdocumentor-description"><p>Moved from <abbr title="\footnotes\general\Footnotes">Footnotes</abbr> to <abbr title="\footnotes\includes\Public">Public</abbr>.</p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">mixed</span> — <section class="phpdocumentor-description"></section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_enqueue_styles"> enqueue_styles() <a href="classes/footnotes-general-General.html#method_enqueue_styles" class="headerlink"><i class="fas fa-link"></i></a> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="src/public/class-general.php"><a href="files/src-public-class-general.html"><abbr title="src/public/class-general.php">class-general.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">159</span> </aside> <p class="phpdocumentor-summary">Register the stylesheets for the public-facing side of the site.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">enqueue_styles</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code> <section class="phpdocumentor-description"><p>Enables enqueuing the formatted individual stylesheets if <abbr title="\footnotes\general\PRODUCTION_ENV">PRODUCTION_ENV</abbr> is <code class="prettyprint">true</code>.</p> </section> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">1.5.0</span> <section class="phpdocumentor-description"></section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">2.5.5</span> <section class="phpdocumentor-description"><p>Change stylesheet schema.</p> </section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">2.8.0</span> <section class="phpdocumentor-description"><p>Moved from <abbr title="\footnotes\general\Footnotes">Footnotes</abbr> to <abbr title="\footnotes\includes\Public">Public</abbr>.</p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">mixed</span> — <section class="phpdocumentor-description"></section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_register_widgets"> register_widgets() <a href="classes/footnotes-general-General.html#method_register_widgets" class="headerlink"><i class="fas fa-link"></i></a> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="src/public/class-general.php"><a href="files/src-public-class-general.html"><abbr title="src/public/class-general.php">class-general.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">273</span> </aside> <p class="phpdocumentor-summary">Register the widget(s) for the public-facing side of the site.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">register_widgets</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">1.5.0</span> <section class="phpdocumentor-description"></section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">2.8.0</span> <section class="phpdocumentor-description"><p>Moved from <abbr title="\footnotes\general\Footnotes">Footnotes</abbr> to <abbr title="\footnotes\includes\Public">Public</abbr>.</p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">mixed</span> — <section class="phpdocumentor-description"></section> </article> <article class="phpdocumentor-element -method -private " > <h4 class="phpdocumentor-element__name" id="method_load_dependencies"> load_dependencies() <a href="classes/footnotes-general-General.html#method_load_dependencies" class="headerlink"><i class="fas fa-link"></i></a> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="src/public/class-general.php"><a href="files/src-public-class-general.html"><abbr title="src/public/class-general.php">class-general.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">135</span> </aside> <p class="phpdocumentor-summary">Load the required public-facing dependencies.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">private</span> <span class="phpdocumentor-signature__name">load_dependencies</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code> <section class="phpdocumentor-description"><p>Include the following files that provide the public-facing functionality of this plugin:</p> <ul> <li> <a href="classes/footnotes-general-Parser.html"><abbr title="\footnotes\general\Parser">Parser</abbr></a>: parses Posts and Pages for footnote shortcodes; and</li> <li> <a href="classes/footnotes-general-Widget-Reference-Container.html"><abbr title="\footnotes\general\Widget\Reference_Container">Reference_Container</abbr></a>: defines the Reference Container widget.</li> </ul> </section> <h5 class="phpdocumentor-tag-list__heading" id="tags"> Tags <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a> </h5> <dl class="phpdocumentor-tag-list"> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">2.8.0</span> <section class="phpdocumentor-description"></section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">mixed</span> — <section class="phpdocumentor-description"></section> </article> </section> </article> <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden"> <section class="phpdocumentor-search-results__dialog"> <header class="phpdocumentor-search-results__header"> <h2 class="phpdocumentor-search-results__title">Search results</h2> <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button> </header> <section class="phpdocumentor-search-results__body"> <ul class="phpdocumentor-search-results__entries"></ul> </section> </section> </section> </div> </div> <a href="classes/footnotes-general-General.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a> </main> <script> cssVars({}); </script> </body> </html>