This repository has been archived on 2023-08-16. You can view files and clone it, but cannot push or open issues or pull requests.
footnotes/docs/classes/footnotes-general-General.html

1239 lines
60 KiB
HTML
Raw Normal View History

2021-05-01 20:39:33 +00:00
<!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">
2021-08-09 10:27:33 +00:00
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
2021-05-01 20:39:33 +00:00
<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" />
2021-08-09 10:27:33 +00:00
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
2021-05-01 20:39:33 +00:00
<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="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">
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
2021-08-09 10:27:33 +00:00
<h3 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/default.html"><abbr title="\">Global</abbr></a></h3>
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h4>
2021-05-01 20:39:33 +00:00
<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>
2021-05-02 20:27:53 +00:00
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
2021-08-09 10:27:33 +00:00
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
2021-05-02 20:27:53 +00:00
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
2021-05-01 20:39:33 +00:00
<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
2021-05-02 20:27:53 +00:00
<div class="phpdocumentor-element__package">
in package
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="packages/footnotes.html">footnotes</a></li>
</ul>
</div>
2021-05-01 20:39:33 +00:00
</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>
:
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">29</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
<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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</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">
2021-05-02 20:27:53 +00:00
<a href="classes/footnotes-general-General.html#property_alternative_tooltips_enabled">$alternative_tooltips_enabled</a>
2021-05-01 20:39:33 +00:00
<span>
&nbsp;: bool </span>
</dt>
<dd>Allows to determine whether alternative tooltips are enabled.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
2021-05-02 20:27:53 +00:00
<a href="classes/footnotes-general-General.html#property_amp_enabled">$amp_enabled</a>
2021-05-01 20:39:33 +00:00
<span>
&nbsp;: bool </span>
</dt>
<dd>Allows to determine whether AMP compatibility mode is enabled.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
2021-05-02 20:27:53 +00:00
<a href="classes/footnotes-general-General.html#property_script_mode">$script_mode</a>
2021-05-01 20:39:33 +00:00
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: string </span>
2021-05-01 20:39:33 +00:00
</dt>
2021-05-02 20:27:53 +00:00
<dd>Allows to determine the script mode among jQuery or plain JS.</dd>
2021-05-01 20:39:33 +00:00
<dt class="phpdocumentor-table-of-contents__entry -property -public">
2021-05-02 20:27:53 +00:00
<a href="classes/footnotes-general-General.html#property_task">$task</a>
2021-05-01 20:39:33 +00:00
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: <a href="classes/footnotes-general-Parser.html"><abbr title="\footnotes\general\Parser">Parser</abbr></a>|null </span>
2021-05-01 20:39:33 +00:00
</dt>
<dd>The footnote parser.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
2021-05-02 20:27:53 +00:00
<a href="classes/footnotes-general-General.html#property_tooltips_enabled">$tooltips_enabled</a>
2021-05-01 20:39:33 +00:00
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: bool </span>
2021-05-01 20:39:33 +00:00
</dt>
2021-05-02 20:27:53 +00:00
<dd>Flag for using tooltips.</dd>
2021-05-01 20:39:33 +00:00
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/footnotes-general-General.html#property_plugin_name">$plugin_name</a>
<span>
&nbsp;: 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>
&nbsp;: <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>
2021-08-09 10:27:33 +00:00
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/footnotes-general-General.html#property_settings">$settings</a>
<span>
&nbsp;: <a href="classes/footnotes-includes-Settings.html"><abbr title="\footnotes\includes\Settings">Settings</abbr></a> </span>
</dt>
<dd>The plugin settings object.</dd>
2021-05-01 20:39:33 +00:00
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/footnotes-general-General.html#property_version">$version</a>
<span>
&nbsp;: 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>
&nbsp;: 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>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</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 "
>
2021-05-02 20:27:53 +00:00
<h4 class="phpdocumentor-element__name" id="property_alternative_tooltips_enabled">
$alternative_tooltips_enabled
<a href="classes/footnotes-general-General.html#property_alternative_tooltips_enabled" class="headerlink"><i class="fas fa-link"></i></a>
2021-05-01 20:39:33 +00:00
<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>
:
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">69</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
<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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">$alternative_tooltips_enabled</span>
2021-05-01 20:39:33 +00:00
= <span class="phpdocumentor-signature__default-value">false</span></code>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</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>
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Moved from <abbr title="\footnotes\includes\Footnotes">Footnotes</abbr> to <a href="classes/footnotes-general-General.html"><abbr title="\footnotes\general\General">General</abbr></a>.</p>
2021-05-01 20:39:33 +00:00
</section>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-public
-static "
>
2021-05-02 20:27:53 +00:00
<h4 class="phpdocumentor-element__name" id="property_amp_enabled">
$amp_enabled
<a href="classes/footnotes-general-General.html#property_amp_enabled" class="headerlink"><i class="fas fa-link"></i></a>
2021-05-01 20:39:33 +00:00
<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>
:
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">79</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
<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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">$amp_enabled</span>
2021-05-01 20:39:33 +00:00
= <span class="phpdocumentor-signature__default-value">false</span></code>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</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>
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Moved from <abbr title="\footnotes\includes\Footnotes">Footnotes</abbr> to <a href="classes/footnotes-general-General.html"><abbr title="\footnotes\general\General">General</abbr></a>.</p>
2021-05-01 20:39:33 +00:00
</section>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-public
-static "
>
2021-05-02 20:27:53 +00:00
<h4 class="phpdocumentor-element__name" id="property_script_mode">
$script_mode
<a href="classes/footnotes-general-General.html#property_script_mode" class="headerlink"><i class="fas fa-link"></i></a>
2021-05-01 20:39:33 +00:00
<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>
:
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">89</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
2021-05-02 20:27:53 +00:00
<p class="phpdocumentor-summary">Allows to determine the script mode among jQuery or plain JS.</p>
2021-05-01 20:39:33 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$script_mode</span>
= <span class="phpdocumentor-signature__default-value">&#039;js&#039;</span></code>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>js to use plain JavaScript, jquery to use jQuery.</p>
</section>
2021-05-01 20:39:33 +00:00
<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">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-tag-link">2.5.6</span>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</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>
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Moved from <abbr title="\footnotes\includes\Footnotes">Footnotes</abbr> to <a href="classes/footnotes-general-General.html"><abbr title="\footnotes\general\General">General</abbr></a>.</p>
2021-05-01 20:39:33 +00:00
</section>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-public
"
>
2021-05-02 20:27:53 +00:00
<h4 class="phpdocumentor-element__name" id="property_task">
$task
<a href="classes/footnotes-general-General.html#property_task" class="headerlink"><i class="fas fa-link"></i></a>
2021-05-01 20:39:33 +00:00
<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>
:
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">49</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">The footnote parser.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__type"><a href="classes/footnotes-general-Parser.html"><abbr title="\footnotes\general\Parser">Parser</abbr></a>|null</span>
<span class="phpdocumentor-signature__name">$task</span>
2021-05-01 20:39:33 +00:00
= <span class="phpdocumentor-signature__default-value">null</span></code>
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>The Plugin task.</p>
</section>
2021-05-01 20:39:33 +00:00
<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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</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>
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Moved from <abbr title="\footnotes\includes\Footnotes">Footnotes</abbr> to <a href="classes/footnotes-general-General.html"><abbr title="\footnotes\general\General">General</abbr></a>.</p>
2021-05-01 20:39:33 +00:00
</section>
2021-05-02 20:27:53 +00:00
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Review null init.</p>
</section>
2021-05-01 20:39:33 +00:00
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-public
-static "
>
2021-05-02 20:27:53 +00:00
<h4 class="phpdocumentor-element__name" id="property_tooltips_enabled">
$tooltips_enabled
<a href="classes/footnotes-general-General.html#property_tooltips_enabled" class="headerlink"><i class="fas fa-link"></i></a>
2021-05-01 20:39:33 +00:00
<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>
:
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">59</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
2021-05-02 20:27:53 +00:00
<p class="phpdocumentor-summary">Flag for using tooltips.</p>
2021-05-01 20:39:33 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">bool</span>
<span class="phpdocumentor-signature__name">$tooltips_enabled</span>
= <span class="phpdocumentor-signature__default-value">false</span></code>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Whether tooltips are enabled or not.</p>
</section>
2021-05-01 20:39:33 +00:00
<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">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-tag-link">2.4.0</span>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</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>
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Moved from <abbr title="\footnotes\includes\Footnotes">Footnotes</abbr> to <a href="classes/footnotes-general-General.html"><abbr title="\footnotes\general\General">General</abbr></a>.</p>
2021-05-01 20:39:33 +00:00
</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>
:
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">106</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
<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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<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">
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-tag__name">access</span>
2021-05-01 20:39:33 +00:00
</dt>
<dd class="phpdocumentor-tag-list__definition">
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>private</p>
</section>
2021-05-01 20:39:33 +00:00
</dd>
<dt class="phpdocumentor-tag-list__entry">
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-tag__name">since</span>
2021-05-01 20:39:33 +00:00
</dt>
<dd class="phpdocumentor-tag-list__definition">
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-tag-link">2.8.0</span>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\footnotes\includes\Footnotes::$plugin_name">Footnotes::$plugin_name</abbr></span>
2021-05-01 20:39:33 +00:00
</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>
:
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">38</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
<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>
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>The reference container widget</p>
</section>
2021-05-01 20:39:33 +00:00
<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>
2021-08-09 10:27:33 +00:00
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_settings">
$settings
<a href="classes/footnotes-general-General.html#property_settings" 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>
:
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">123</span>
2021-08-09 10:27:33 +00:00
</aside>
<p class="phpdocumentor-summary">The plugin settings object.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type"><a href="classes/footnotes-includes-Settings.html"><abbr title="\footnotes\includes\Settings">Settings</abbr></a></span>
<span class="phpdocumentor-signature__name">$settings</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">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>private</p>
</section>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
</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>
2021-05-01 20:39:33 +00:00
</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>
:
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">115</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
<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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<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">
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-tag__name">access</span>
2021-05-01 20:39:33 +00:00
</dt>
<dd class="phpdocumentor-tag-list__definition">
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>private</p>
</section>
2021-05-01 20:39:33 +00:00
</dd>
<dt class="phpdocumentor-tag-list__entry">
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-tag__name">since</span>
2021-05-01 20:39:33 +00:00
</dt>
<dd class="phpdocumentor-tag-list__definition">
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-tag-link">2.8.0</span>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\footnotes\includes\Footnotes::$version">Footnotes::$version</abbr></span>
2021-05-01 20:39:33 +00:00
</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>
:
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">98</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
<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>
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$version</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/footnotes-includes-Settings.html"><abbr title="\footnotes\includes\Settings">Settings</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$settings</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<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>
2021-08-09 10:27:33 +00:00
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$settings</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/footnotes-includes-Settings.html"><abbr title="\footnotes\includes\Settings">Settings</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
2021-05-01 20:39:33 +00:00
</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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</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>
:
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">249</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
<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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">enqueue_scripts</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</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>
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Moved from <abbr title="\footnotes\includes\Footnotes">Footnotes</abbr> to <a href="classes/footnotes-general-General.html"><abbr title="\footnotes\general\General">General</abbr></a>.</p>
2021-05-01 20:39:33 +00:00
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&mdash;
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</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>
:
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">170</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
<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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">enqueue_styles</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</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>
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Moved from <abbr title="\footnotes\includes\Footnotes">Footnotes</abbr> to <a href="classes/footnotes-general-General.html"><abbr title="\footnotes\general\General">General</abbr></a>.</p>
2021-05-01 20:39:33 +00:00
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&mdash;
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</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>
:
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">298</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
<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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">register_widgets</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</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>
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Moved from <abbr title="\footnotes\includes\Footnotes">Footnotes</abbr> to <a href="classes/footnotes-general-General.html"><abbr title="\footnotes\general\General">General</abbr></a>.</p>
2021-05-01 20:39:33 +00:00
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&mdash;
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</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>
:
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">146</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">Load the required public-facing dependencies.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">load_dependencies</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&mdash;
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</article>
</section>
2021-08-09 10:27:33 +00:00
<script type="text/javascript">
function loadExternalCodeSnippets(line) {
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
var src = pre.getAttribute('data-src').replace( /\\/g, '/');
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
var language = 'php';
var code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
}
else if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
}
else {
code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
}
}
};
xhr.send(null);
});
}
var modals = document.querySelectorAll("[data-modal]");
modals.forEach(function (trigger) {
trigger.addEventListener("click", function (event) {
//event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippets(trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
</script>
2021-05-01 20:39:33 +00:00
</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>
2021-08-09 10:27:33 +00:00
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
2021-05-01 20:39:33 +00:00
</body>
</html>