Rumperuu/footnotes
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs: update documentation

Browse source
This commit is contained in:
Ben Goldsworthy 2021-05-02 21:27:53 +01:00
parent ebcba982e6
commit 5afd55dba6
56 changed files with 5566 additions and 5217 deletions
Download patch file Download diff file Expand all files Collapse all files

198
docs/classes/footnotes-admin-Admin.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
@ -84,6 +92,12 @@
Admin
<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>
</h2>
@ -91,7 +105,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-admin.php"><a href="files/src-admin-class-admin.html"><abbr title="src/admin/class-admin.php">class-admin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Class provide all admin-specific functionality of the plugin.</p>
@ -135,20 +149,6 @@ and JavaScript.</p>
</dt>
<dd>The WYSIWYG editor integration object.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/footnotes-admin-Admin.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-admin-Admin.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-admin-Admin.html#method___construct">__construct()</a>
<span>
@ -166,21 +166,21 @@ and JavaScript.</p>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-Admin.html#method_enqueue_scripts">enqueue_scripts()</a>
<span>
&nbsp;: mixed </span>
&nbsp;: void </span>
</dt>
<dd>Register the JavaScript for the admin area.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-Admin.html#method_enqueue_styles">enqueue_styles()</a>
<span>
&nbsp;: mixed </span>
&nbsp;: void </span>
</dt>
<dd>Register the stylesheets for the admin area.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/footnotes-admin-Admin.html#method_load_dependencies">load_dependencies()</a>
<span>
&nbsp;: mixed </span>
&nbsp;: void </span>
</dt>
<dd>Load the required admin-specific dependencies.</dd>
@ -212,7 +212,7 @@ and JavaScript.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-admin.php"><a href="files/src-admin-class-admin.html"><abbr title="src/admin/class-admin.php">class-admin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">55</span>
<span class="phpdocumentor-element-found-in__line">37</span>
</aside>
<p class="phpdocumentor-summary">The WYSIWYG editor integration object.</p>
@ -242,136 +242,6 @@ and JavaScript.</p>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_plugin_name">
$plugin_name
<a href="classes/footnotes-admin-Admin.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/admin/class-admin.php"><a href="files/src-admin-class-admin.html"><abbr title="src/admin/class-admin.php">class-admin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">37</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">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>private</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"></section>
</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>
<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-admin-Admin.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/admin/class-admin.php"><a href="files/src-admin-class-admin.html"><abbr title="src/admin/class-admin.php">class-admin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">47</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">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>private</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"></section>
</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>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
</article>
</section>
@ -393,7 +263,7 @@ and JavaScript.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-admin.php"><a href="files/src-admin-class-admin.html"><abbr title="src/admin/class-admin.php">class-admin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">65</span>
<span class="phpdocumentor-element-found-in__line">44</span>
</aside>
<p class="phpdocumentor-summary">Initialize the class and set its properties.</p>
@ -411,18 +281,14 @@ and JavaScript.</p>
: <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>
@ -463,7 +329,7 @@ and JavaScript.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-admin.php"><a href="files/src-admin-class-admin.html"><abbr title="src/admin/class-admin.php">class-admin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">153</span>
<span class="phpdocumentor-element-found-in__line">119</span>
</aside>
<p class="phpdocumentor-summary">Appends the Plugin links for display in the dashboard Plugins page.</p>
@ -535,14 +401,14 @@ and JavaScript.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-admin.php"><a href="files/src-admin-class-admin.html"><abbr title="src/admin/class-admin.php">class-admin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">128</span>
<span class="phpdocumentor-element-found-in__line">94</span>
</aside>
<p class="phpdocumentor-summary">Register the JavaScript for the admin area.</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>
<span class="phpdocumentor-signature__name">enqueue_scripts</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
@ -565,7 +431,7 @@ and JavaScript.</p>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
@ -584,14 +450,14 @@ and JavaScript.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-admin.php"><a href="files/src-admin-class-admin.html"><abbr title="src/admin/class-admin.php">class-admin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">108</span>
<span class="phpdocumentor-element-found-in__line">73</span>
</aside>
<p class="phpdocumentor-summary">Register the stylesheets for the admin area.</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>
<span class="phpdocumentor-signature__name">enqueue_styles</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
@ -614,7 +480,7 @@ and JavaScript.</p>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
@ -633,14 +499,14 @@ and JavaScript.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-admin.php"><a href="files/src-admin-class-admin.html"><abbr title="src/admin/class-admin.php">class-admin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
<span class="phpdocumentor-element-found-in__line">141</span>
</aside>
<p class="phpdocumentor-summary">Load the required admin-specific 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>
<span class="phpdocumentor-signature__name">load_dependencies</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>Includes the following files that provide the admin-specific functionality
of this plugin:</p>
@ -680,7 +546,7 @@ of this plugin:</p>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>

183
docs/classes/footnotes-admin-WYSIWYG.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
@ -84,6 +92,12 @@
WYSIWYG
<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>
</h2>
@ -91,7 +105,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-wysiwyg.php"><a href="files/src-admin-class-wysiwyg.html"><abbr title="src/admin/class-wysiwyg.php">class-wysiwyg.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
<span class="phpdocumentor-element-found-in__line">28</span>
</aside>
<p class="phpdocumentor-summary">Class providing WYSIWYG editor intergration for the plugin.</p>
@ -126,24 +140,10 @@
</h3>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/footnotes-admin-WYSIWYG.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 -method -public">
<a href="classes/footnotes-admin-WYSIWYG.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">
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-WYSIWYG.html#method_ajax_callback">ajax_callback()</a>
<span>
&nbsp;: mixed </span>
&nbsp;: void </span>
</dt>
<dd>AJAX Callback function when the Footnotes Button is clicked. Either in the Plain text or Visual editor.</dd>
@ -157,7 +157,7 @@
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-WYSIWYG.html#method_new_plain_text_editor_button">new_plain_text_editor_button()</a>
<span>
&nbsp;: mixed </span>
&nbsp;: void </span>
</dt>
<dd>Add a new button to the plain text editor.</dd>
@ -175,68 +175,6 @@
<section class="phpdocumentor-properties">
<h3 class="phpdocumentor-elements__header" id="properties">
Properties
<a href="classes/footnotes-admin-WYSIWYG.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_plugin_name">
$plugin_name
<a href="classes/footnotes-admin-WYSIWYG.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/admin/class-wysiwyg.php"><a href="files/src-admin-class-wysiwyg.html"><abbr title="src/admin/class-wysiwyg.php">class-wysiwyg.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">36</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">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>private</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"></section>
</dd>
</dl>
</article>
</section>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
@ -244,67 +182,6 @@
<a href="classes/footnotes-admin-WYSIWYG.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-admin-WYSIWYG.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/admin/class-wysiwyg.php"><a href="files/src-admin-class-wysiwyg.html"><abbr title="src/admin/class-wysiwyg.php">class-wysiwyg.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">45</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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$plugin_name</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>
</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>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
@ -317,14 +194,14 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-wysiwyg.php"><a href="files/src-admin-class-wysiwyg.html"><abbr title="src/admin/class-wysiwyg.php">class-wysiwyg.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">97</span>
<span class="phpdocumentor-element-found-in__line">76</span>
</aside>
<p class="phpdocumentor-summary">AJAX Callback function when the Footnotes Button is clicked. Either in the Plain text or Visual editor.</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__name">ajax_callback</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">ajax_callback</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>Returns an JSON encoded array with the Footnotes start and end short code.</p>
</section>
@ -348,7 +225,7 @@
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
@ -367,21 +244,21 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-wysiwyg.php"><a href="files/src-admin-class-wysiwyg.html"><abbr title="src/admin/class-wysiwyg.php">class-wysiwyg.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">86</span>
<span class="phpdocumentor-element-found-in__line">65</span>
</aside>
<p class="phpdocumentor-summary">Includes the Plugins WYSIWYG editor script.</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__name">include_scripts</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, string&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_arr_plugins</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, string&gt;</span></code>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">include_scripts</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, string&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$plugins</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, string&gt;</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">$p_arr_plugins</span>
<span class="phpdocumentor-signature__argument__name">$plugins</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, string&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
@ -437,14 +314,14 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-wysiwyg.php"><a href="files/src-admin-class-wysiwyg.html"><abbr title="src/admin/class-wysiwyg.php">class-wysiwyg.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">70</span>
<span class="phpdocumentor-element-found-in__line">49</span>
</aside>
<p class="phpdocumentor-summary">Add a new button to the plain text editor.</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__name">new_plain_text_editor_button</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">new_plain_text_editor_button</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
@ -467,7 +344,7 @@
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
@ -486,21 +363,21 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-wysiwyg.php"><a href="files/src-admin-class-wysiwyg.html"><abbr title="src/admin/class-wysiwyg.php">class-wysiwyg.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">60</span>
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Append a new Button to the WYSIWYG editor of Posts and Pages.</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__name">new_visual_editor_button</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, string&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_arr_buttons</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, string&gt;</span></code>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">new_visual_editor_button</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, string&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$buttons</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, string&gt;</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">$p_arr_buttons</span>
<span class="phpdocumentor-signature__argument__name">$buttons</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, string&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">

456
docs/classes/footnotes-admin-layout-Engine.html
View file

File diff suppressed because it is too large Load diff

141
docs/classes/footnotes-admin-layout-Init.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
@ -85,6 +93,12 @@
Init
<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>
</h2>
@ -92,7 +106,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-init.php"><a href="files/src-admin-layout-class-init.html"><abbr title="src/admin/layout/class-init.php">class-init.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
<span class="phpdocumentor-element-found-in__line">28</span>
</aside>
<p class="phpdocumentor-summary">Class to initialise all defined page layouts.</p>
@ -128,21 +142,14 @@
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/footnotes-admin-layout-Init.html#constant_C_STR_MAIN_MENU_SLUG">C_STR_MAIN_MENU_SLUG</a>
<a href="classes/footnotes-admin-layout-Init.html#constant_MAIN_MENU_SLUG">MAIN_MENU_SLUG</a>
<span>
&nbsp;= &#039;footnotes&#039; </span>
</dt>
<dd>Slug for the Plugin main menu.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/footnotes-admin-layout-Init.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-admin-layout-Init.html#property_settings_page">$settings_page</a>
<a href="classes/footnotes-admin-layout-Init.html#property_settings">$settings</a>
<span>
&nbsp;: <a href="classes/footnotes-admin-layout-Settings.html"><abbr title="\footnotes\admin\layout\Settings">Settings</abbr></a> </span>
</dt>
@ -158,28 +165,28 @@
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-layout-Init.html#method_get_plugin_meta_information">get_plugin_meta_information()</a>
<span>
&nbsp;: mixed </span>
&nbsp;: void </span>
</dt>
<dd>AJAX call. returns a JSON string containing meta information about a specific WordPress Plugin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-layout-Init.html#method_initialize_settings">initialize_settings()</a>
<span>
&nbsp;: mixed </span>
&nbsp;: void </span>
</dt>
<dd>Registers the settings and initialises the settings page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-layout-Init.html#method_register_options_submenu">register_options_submenu()</a>
<span>
&nbsp;: mixed </span>
&nbsp;: void </span>
</dt>
<dd>Registers the footnotes submenu page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/footnotes-admin-layout-Init.html#method_load_dependencies">load_dependencies()</a>
<span>
&nbsp;: mixed </span>
&nbsp;: void </span>
</dt>
<dd>Load the required dependencies for the layouts pages.</dd>
@ -194,15 +201,15 @@
<a href="classes/footnotes-admin-layout-Init.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_C_STR_MAIN_MENU_SLUG">
C_STR_MAIN_MENU_SLUG
<a href="classes/footnotes-admin-layout-Init.html#constant_C_STR_MAIN_MENU_SLUG" class="headerlink"><i class="fas fa-link"></i></a>
<h4 class="phpdocumentor-element__name" id="constant_MAIN_MENU_SLUG">
MAIN_MENU_SLUG
<a href="classes/footnotes-admin-layout-Init.html#constant_MAIN_MENU_SLUG" 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/admin/layout/class-init.php"><a href="files/src-admin-layout-class-init.html"><abbr title="src/admin/layout/class-init.php">class-init.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">45</span>
<span class="phpdocumentor-element-found-in__line">37</span>
</aside>
<p class="phpdocumentor-summary">Slug for the Plugin main menu.</p>
@ -210,7 +217,7 @@
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">C_STR_MAIN_MENU_SLUG</span>
<span class="phpdocumentor-signature__name">MAIN_MENU_SLUG</span>
= <span class="phpdocumentor-signature__default-value">&#039;footnotes&#039;</span>
</code>
@ -250,72 +257,16 @@
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_plugin_name">
$plugin_name
<a href="classes/footnotes-admin-layout-Init.html#property_plugin_name" class="headerlink"><i class="fas fa-link"></i></a>
<h4 class="phpdocumentor-element__name" id="property_settings">
$settings
<a href="classes/footnotes-admin-layout-Init.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/admin/layout/class-init.php"><a href="files/src-admin-layout-class-init.html"><abbr title="src/admin/layout/class-init.php">class-init.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">36</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">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>private</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"></section>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_settings_page">
$settings_page
<a href="classes/footnotes-admin-layout-Init.html#property_settings_page" 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/admin/layout/class-init.php"><a href="files/src-admin-layout-class-init.html"><abbr title="src/admin/layout/class-init.php">class-init.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">54</span>
<span class="phpdocumentor-element-found-in__line">46</span>
</aside>
<p class="phpdocumentor-summary">Contains the settings page.</p>
@ -323,7 +274,7 @@
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type"><a href="classes/footnotes-admin-layout-Settings.html"><abbr title="\footnotes\admin\layout\Settings">Settings</abbr></a></span>
<span class="phpdocumentor-signature__name">$settings_page</span>
<span class="phpdocumentor-signature__name">$settings</span>
</code>
<section class="phpdocumentor-description"></section>
@ -366,7 +317,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-init.php"><a href="files/src-admin-layout-class-init.html"><abbr title="src/admin/layout/class-init.php">class-init.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">64</span>
<span class="phpdocumentor-element-found-in__line">54</span>
</aside>
<p class="phpdocumentor-summary">Initializes all WordPress hooks for the Plugin Settings.</p>
@ -384,9 +335,7 @@
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The name of the plugin.</p>
</section>
</dd>
</dl>
@ -437,14 +386,14 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-init.php"><a href="files/src-admin-layout-class-init.html"><abbr title="src/admin/layout/class-init.php">class-init.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">143</span>
<span class="phpdocumentor-element-found-in__line">123</span>
</aside>
<p class="phpdocumentor-summary">AJAX call. returns a JSON string containing meta information about a specific WordPress Plugin.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">get_plugin_meta_information</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<span class="phpdocumentor-signature__name">get_plugin_meta_information</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
@ -467,7 +416,7 @@
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
@ -486,14 +435,14 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-init.php"><a href="files/src-admin-layout-class-init.html"><abbr title="src/admin/layout/class-init.php">class-init.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">114</span>
<span class="phpdocumentor-element-found-in__line">94</span>
</aside>
<p class="phpdocumentor-summary">Registers the settings and initialises the settings page.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">initialize_settings</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<span class="phpdocumentor-signature__name">initialize_settings</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
@ -516,7 +465,7 @@
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
@ -535,14 +484,14 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-init.php"><a href="files/src-admin-layout-class-init.html"><abbr title="src/admin/layout/class-init.php">class-init.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">125</span>
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Registers the footnotes submenu page.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">register_options_submenu</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<span class="phpdocumentor-signature__name">register_options_submenu</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
@ -574,7 +523,7 @@
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
@ -593,14 +542,14 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-init.php"><a href="files/src-admin-layout-class-init.html"><abbr title="src/admin/layout/class-init.php">class-init.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">92</span>
<span class="phpdocumentor-element-found-in__line">193</span>
</aside>
<p class="phpdocumentor-summary">Load the required dependencies for the layouts pages.</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>
<span class="phpdocumentor-signature__name">load_dependencies</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>Include the following files that make up the plugin:</p>
<ul>
@ -641,7 +590,7 @@
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>

656
docs/classes/footnotes-admin-layout-Settings.html
View file

File diff suppressed because it is too large Load diff

357
docs/classes/footnotes-general-General.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
@ -84,6 +92,12 @@
General
<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>
</h2>
@ -91,7 +105,7 @@
<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>
<span class="phpdocumentor-element-found-in__line">24</span>
</aside>
<p class="phpdocumentor-summary">Class provide all public-facing functionality of the plugin.</p>
@ -129,40 +143,40 @@ and JavaScript.</p>
<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>
<a href="classes/footnotes-general-General.html#property_alternative_tooltips_enabled">$alternative_tooltips_enabled</a>
<span>
&nbsp;: 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>
<a href="classes/footnotes-general-General.html#property_amp_enabled">$amp_enabled</a>
<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">
<a href="classes/footnotes-general-General.html#property_a_bool_tooltips_enabled">$a_bool_tooltips_enabled</a>
<span>
&nbsp;: 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>
&nbsp;: <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>
<a href="classes/footnotes-general-General.html#property_script_mode">$script_mode</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Allows to determine the script mode among jQuery or plain JS.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a href="classes/footnotes-general-General.html#property_task">$task</a>
<span>
&nbsp;: <a href="classes/footnotes-general-Parser.html"><abbr title="\footnotes\general\Parser">Parser</abbr></a>|null </span>
</dt>
<dd>The footnote parser.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a href="classes/footnotes-general-General.html#property_tooltips_enabled">$tooltips_enabled</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Flag for using tooltips.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/footnotes-general-General.html#property_plugin_name">$plugin_name</a>
<span>
@ -194,28 +208,28 @@ and JavaScript.</p>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-general-General.html#method_enqueue_scripts">enqueue_scripts()</a>
<span>
&nbsp;: mixed </span>
&nbsp;: void </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>
&nbsp;: mixed </span>
&nbsp;: void </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>
&nbsp;: mixed </span>
&nbsp;: void </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>
&nbsp;: mixed </span>
&nbsp;: void </span>
</dt>
<dd>Load the required public-facing dependencies.</dd>
@ -238,16 +252,16 @@ and JavaScript.</p>
-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>
<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>
<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>
<span class="phpdocumentor-element-found-in__line">84</span>
</aside>
<p class="phpdocumentor-summary">Allows to determine whether alternative tooltips are enabled.</p>
@ -255,7 +269,7 @@ and JavaScript.</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__name">$alternative_tooltips_enabled</span>
= <span class="phpdocumentor-signature__default-value">false</span></code>
<section class="phpdocumentor-description"></section>
@ -295,16 +309,16 @@ and JavaScript.</p>
-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>
<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>
<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>
<span class="phpdocumentor-element-found-in__line">94</span>
</aside>
<p class="phpdocumentor-summary">Allows to determine whether AMP compatibility mode is enabled.</p>
@ -312,7 +326,7 @@ and JavaScript.</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__name">$amp_enabled</span>
= <span class="phpdocumentor-signature__default-value">false</span></code>
<section class="phpdocumentor-description"></section>
@ -352,130 +366,16 @@ and JavaScript.</p>
-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>
<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>
<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>
<span class="phpdocumentor-element-found-in__line">104</span>
</aside>
<p class="phpdocumentor-summary">Allows to determine the script mode among jQuery or plain JS.</p>
@ -483,7 +383,7 @@ and JavaScript.</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__name">$script_mode</span>
= <span class="phpdocumentor-signature__default-value">&#039;js&#039;</span></code>
<section class="phpdocumentor-description"></section>
@ -515,6 +415,129 @@ and JavaScript.</p>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-public
"
>
<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>
<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">64</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>|null</span>
<span class="phpdocumentor-signature__name">$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>
<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>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-public
-static "
>
<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>
<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">74</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">$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="
@ -532,7 +555,7 @@ and JavaScript.</p>
<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>
<span class="phpdocumentor-element-found-in__line">34</span>
</aside>
<p class="phpdocumentor-summary">The ID of this plugin.</p>
@ -588,7 +611,7 @@ and JavaScript.</p>
<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>
<span class="phpdocumentor-element-found-in__line">53</span>
</aside>
<p class="phpdocumentor-summary">The reference container widget.</p>
@ -635,7 +658,7 @@ and JavaScript.</p>
<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>
<span class="phpdocumentor-element-found-in__line">44</span>
</aside>
<p class="phpdocumentor-summary">The version of this plugin.</p>
@ -695,7 +718,7 @@ and JavaScript.</p>
<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>
<span class="phpdocumentor-element-found-in__line">113</span>
</aside>
<p class="phpdocumentor-summary">Initialize the class and set its properties.</p>
@ -765,14 +788,14 @@ and JavaScript.</p>
<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>
<span class="phpdocumentor-element-found-in__line">241</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>
<span class="phpdocumentor-signature__name">enqueue_scripts</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
@ -835,7 +858,7 @@ and JavaScript.</p>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
@ -854,14 +877,14 @@ and JavaScript.</p>
<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>
<span class="phpdocumentor-element-found-in__line">162</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>
<span class="phpdocumentor-signature__name">enqueue_styles</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</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>
@ -906,7 +929,7 @@ is <code class="prettyprint">true</code>.</p>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
@ -925,14 +948,14 @@ is <code class="prettyprint">true</code>.</p>
<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>
<span class="phpdocumentor-element-found-in__line">290</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>
<span class="phpdocumentor-signature__name">register_widgets</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
@ -965,7 +988,7 @@ is <code class="prettyprint">true</code>.</p>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
@ -984,14 +1007,14 @@ is <code class="prettyprint">true</code>.</p>
<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>
<span class="phpdocumentor-element-found-in__line">138</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>
<span class="phpdocumentor-signature__name">load_dependencies</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>Include the following files that provide the public-facing functionality
of this plugin:</p>
@ -1022,7 +1045,7 @@ of this plugin:</p>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>

1217
docs/classes/footnotes-general-Parser.html
View file

File diff suppressed because it is too large Load diff

26
docs/classes/footnotes-general-Widget-Base.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
@ -88,6 +96,12 @@
extends <abbr title="\WP_Widget">WP_Widget</abbr>
</span>
<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>
</h2>
@ -95,7 +109,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/public/widget/class-base.php"><a href="files/src-public-widget-class-base.html"><abbr title="src/public/widget/class-base.php">class-base.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">Base class to be extended by all widget sub-classes.</p>
@ -210,7 +224,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/public/widget/class-base.php"><a href="files/src-public-widget-class-base.html"><abbr title="src/public/widget/class-base.php">class-base.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">77</span>
<span class="phpdocumentor-element-found-in__line">79</span>
</aside>
<p class="phpdocumentor-summary">Registers the child Widget to WordPress.</p>
@ -259,7 +273,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/public/widget/class-base.php"><a href="files/src-public-widget-class-base.html"><abbr title="src/public/widget/class-base.php">class-base.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">59</span>
<span class="phpdocumentor-element-found-in__line">61</span>
</aside>
<p class="phpdocumentor-summary">Returns the Description of the child widget.</p>
@ -316,7 +330,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/public/widget/class-base.php"><a href="files/src-public-widget-class-base.html"><abbr title="src/public/widget/class-base.php">class-base.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">39</span>
<span class="phpdocumentor-element-found-in__line">41</span>
</aside>
<p class="phpdocumentor-summary">Returns an unique ID as string used for the Widget Base ID.</p>
@ -373,7 +387,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/public/widget/class-base.php"><a href="files/src-public-widget-class-base.html"><abbr title="src/public/widget/class-base.php">class-base.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">49</span>
<span class="phpdocumentor-element-found-in__line">51</span>
</aside>
<p class="phpdocumentor-summary">Returns the Public name of child Widget to be displayed in the Configuration page.</p>
@ -430,7 +444,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/public/widget/class-base.php"><a href="files/src-public-widget-class-base.html"><abbr title="src/public/widget/class-base.php">class-base.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">68</span>
<span class="phpdocumentor-element-found-in__line">70</span>
</aside>
<p class="phpdocumentor-summary">Returns the width of the Widget. Default width is 250 pixel.</p>

32
docs/classes/footnotes-general-Widget-Reference-Container.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
@ -88,6 +96,12 @@
extends <a href="classes/footnotes-general-Widget-Base.html"><abbr title="\footnotes\general\Widget\Base">Base</abbr></a>
</span>
<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>
</h2>
@ -95,7 +109,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/public/widget/class-reference-container.php"><a href="files/src-public-widget-class-reference-container.html"><abbr title="src/public/widget/class-reference-container.php">class-reference-container.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<p class="phpdocumentor-summary">Registers a Widget to put the Reference Container to the widget area.</p>
@ -232,7 +246,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/public/widget/class-reference-container.php"><a href="files/src-public-widget-class-reference-container.html"><abbr title="src/public/widget/class-reference-container.php">class-reference-container.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">37</span>
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<p class="phpdocumentor-summary">The ID of this plugin.</p>
@ -301,7 +315,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/public/widget/class-reference-container.php"><a href="files/src-public-widget-class-reference-container.html"><abbr title="src/public/widget/class-reference-container.php">class-reference-container.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">46</span>
<span class="phpdocumentor-element-found-in__line">49</span>
</aside>
<p class="phpdocumentor-summary">Initialize the class and set its properties.</p>
@ -362,7 +376,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/public/widget/class-reference-container.php"><a href="files/src-public-widget-class-reference-container.html"><abbr title="src/public/widget/class-reference-container.php">class-reference-container.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">95</span>
<span class="phpdocumentor-element-found-in__line">98</span>
</aside>
<p class="phpdocumentor-summary">Outputs the Settings of the Widget.</p>
@ -431,7 +445,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/public/widget/class-reference-container.php"><a href="files/src-public-widget-class-reference-container.html"><abbr title="src/public/widget/class-reference-container.php">class-reference-container.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">108</span>
<span class="phpdocumentor-element-found-in__line">111</span>
</aside>
<p class="phpdocumentor-summary">Outputs the Content of the Widget.</p>
@ -509,7 +523,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/public/widget/class-reference-container.php"><a href="files/src-public-widget-class-reference-container.html"><abbr title="src/public/widget/class-reference-container.php">class-reference-container.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">83</span>
<span class="phpdocumentor-element-found-in__line">86</span>
</aside>
<p class="phpdocumentor-summary">Returns the Description of the child widget.</p>
@ -567,7 +581,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/public/widget/class-reference-container.php"><a href="files/src-public-widget-class-reference-container.html"><abbr title="src/public/widget/class-reference-container.php">class-reference-container.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">59</span>
<span class="phpdocumentor-element-found-in__line">62</span>
</aside>
<p class="phpdocumentor-summary">Returns an unique ID as string used for the Widget Base ID.</p>
@ -625,7 +639,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/public/widget/class-reference-container.php"><a href="files/src-public-widget-class-reference-container.html"><abbr title="src/public/widget/class-reference-container.php">class-reference-container.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">71</span>
<span class="phpdocumentor-element-found-in__line">74</span>
</aside>
<p class="phpdocumentor-summary">Returns the Public name of the Widget to be displayed in the Configuration page.</p>
@ -683,7 +697,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/public/widget/class-base.php"><a href="files/src-public-widget-class-base.html"><abbr title="src/public/widget/class-base.php">class-base.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">68</span>
<span class="phpdocumentor-element-found-in__line">70</span>
</aside>
<p class="phpdocumentor-summary">Returns the width of the Widget. Default width is 250 pixel.</p>

18
docs/classes/footnotes-includes-Activator.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
@ -84,6 +92,12 @@
Activator
<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>
</h2>
@ -91,7 +105,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-activator.php"><a href="files/src-includes-class-activator.html"><abbr title="src/includes/class-activator.php">class-activator.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">38</span>
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<p class="phpdocumentor-summary">Class providing action(s) on plugin activation.</p>
@ -160,7 +174,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-activator.php"><a href="files/src-includes-class-activator.html"><abbr title="src/includes/class-activator.php">class-activator.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">49</span>
<span class="phpdocumentor-element-found-in__line">51</span>
</aside>
<p class="phpdocumentor-summary">Runs when the plugin is deactivated.</p>

76
docs/classes/footnotes-includes-Config.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
@ -84,6 +92,12 @@
Config
<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>
</h2>
@ -91,7 +105,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-config.php"><a href="files/src-includes-class-config.html"><abbr title="src/includes/class-config.php">class-config.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">46</span>
<span class="phpdocumentor-element-found-in__line">48</span>
</aside>
<p class="phpdocumentor-summary">Class defining plugin constants.</p>
@ -156,35 +170,35 @@ Moved under <code class="prettyprint">footnotes\includes</code> namespace.</p>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/footnotes-includes-Config.html#constant_C_STR_LOVE_SYMBOL">C_STR_LOVE_SYMBOL</a>
<a href="classes/footnotes-includes-Config.html#constant_LOVE_SYMBOL">LOVE_SYMBOL</a>
<span>
&nbsp;= &#039;&lt;span style=&quot;color:#ff6d3b; font-weight:bold;&quot;&gt;&amp;hearts;&lt;/span&gt;&#039; </span>
</dt>
<dd>HTML element for the ‘love’ symbol.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/footnotes-includes-Config.html#constant_C_STR_LOVE_SYMBOL_HEADING">C_STR_LOVE_SYMBOL_HEADING</a>
<a href="classes/footnotes-includes-Config.html#constant_LOVE_SYMBOL_HEADING">LOVE_SYMBOL_HEADING</a>
<span>
&nbsp;= &#039;&lt;span class=&quot;footnotes_heart_heading&quot;&gt;&amp;hearts;&lt;/span&gt;&#039; </span>
</dt>
<dd>HTML element for the ‘love’ symbol used in dashboard heading</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/footnotes-includes-Config.html#constant_C_STR_NO_LOVE_SLUG">C_STR_NO_LOVE_SLUG</a>
<a href="classes/footnotes-includes-Config.html#constant_NO_LOVE_SLUG">NO_LOVE_SLUG</a>
<span>
&nbsp;= &#039;[[no footnotes: love]]&#039; </span>
</dt>
<dd>Shortcode to NOT display the ‘LOVE ME’ slug on certain pages.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/footnotes-includes-Config.html#constant_C_STR_PLUGIN_HEADING_NAME">C_STR_PLUGIN_HEADING_NAME</a>
<a href="classes/footnotes-includes-Config.html#constant_PLUGIN_HEADING_NAME">PLUGIN_HEADING_NAME</a>
<span>
&nbsp;= &#039;&lt;span class=&quot;footnotes_logo_heading footnotes_logo_part1_heading&quot;&gt;foot&lt;/span&gt;&lt;span class=&quot;footnotes_logo_heading footnotes_logo_part2_heading&quot;&gt;notes&lt;/span&gt;&#039; </span>
</dt>
<dd>Public plugin name for use as a dashboard heading.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/footnotes-includes-Config.html#constant_C_STR_PLUGIN_PUBLIC_NAME">C_STR_PLUGIN_PUBLIC_NAME</a>
<a href="classes/footnotes-includes-Config.html#constant_PLUGIN_PUBLIC_NAME">PLUGIN_PUBLIC_NAME</a>
<span>
&nbsp;= &#039;&lt;span class=&quot;footnotes_logo footnotes_logo_part1&quot;&gt;foot&lt;/span&gt;&lt;span class=&quot;footnotes_logo footnotes_logo_part2&quot;&gt;notes&lt;/span&gt;&#039; </span>
</dt>
@ -201,15 +215,15 @@ Moved under <code class="prettyprint">footnotes\includes</code> namespace.</p>
<a href="classes/footnotes-includes-Config.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article class="phpdocumentor-element -constant -public -deprecated">
<h4 class="phpdocumentor-element__name" id="constant_C_STR_LOVE_SYMBOL">
C_STR_LOVE_SYMBOL
<a href="classes/footnotes-includes-Config.html#constant_C_STR_LOVE_SYMBOL" class="headerlink"><i class="fas fa-link"></i></a>
<h4 class="phpdocumentor-element__name" id="constant_LOVE_SYMBOL">
LOVE_SYMBOL
<a href="classes/footnotes-includes-Config.html#constant_LOVE_SYMBOL" 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/includes/class-config.php"><a href="files/src-includes-class-config.html"><abbr title="src/includes/class-config.php">class-config.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">84</span>
<span class="phpdocumentor-element-found-in__line">86</span>
</aside>
<p class="phpdocumentor-summary">HTML element for the ‘love’ symbol.</p>
@ -217,7 +231,7 @@ Moved under <code class="prettyprint">footnotes\includes</code> namespace.</p>
<code class="phpdocumentor-signature phpdocumentor-code -deprecated">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">C_STR_LOVE_SYMBOL</span>
<span class="phpdocumentor-signature__name">LOVE_SYMBOL</span>
= <span class="phpdocumentor-signature__default-value">&#039;&lt;span style=&quot;color:#ff6d3b; font-weight:bold;&quot;&gt;&amp;hearts;&lt;/span&gt;&#039;</span>
</code>
@ -260,15 +274,15 @@ Moved under <code class="prettyprint">footnotes\includes</code> namespace.</p>
</article>
<article class="phpdocumentor-element -constant -public -deprecated">
<h4 class="phpdocumentor-element__name" id="constant_C_STR_LOVE_SYMBOL_HEADING">
C_STR_LOVE_SYMBOL_HEADING
<a href="classes/footnotes-includes-Config.html#constant_C_STR_LOVE_SYMBOL_HEADING" class="headerlink"><i class="fas fa-link"></i></a>
<h4 class="phpdocumentor-element__name" id="constant_LOVE_SYMBOL_HEADING">
LOVE_SYMBOL_HEADING
<a href="classes/footnotes-includes-Config.html#constant_LOVE_SYMBOL_HEADING" 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/includes/class-config.php"><a href="files/src-includes-class-config.html"><abbr title="src/includes/class-config.php">class-config.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">95</span>
<span class="phpdocumentor-element-found-in__line">97</span>
</aside>
<p class="phpdocumentor-summary">HTML element for the ‘love’ symbol used in dashboard heading</p>
@ -276,7 +290,7 @@ Moved under <code class="prettyprint">footnotes\includes</code> namespace.</p>
<code class="phpdocumentor-signature phpdocumentor-code -deprecated">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">C_STR_LOVE_SYMBOL_HEADING</span>
<span class="phpdocumentor-signature__name">LOVE_SYMBOL_HEADING</span>
= <span class="phpdocumentor-signature__default-value">&#039;&lt;span class=&quot;footnotes_heart_heading&quot;&gt;&amp;hearts;&lt;/span&gt;&#039;</span>
</code>
@ -319,15 +333,15 @@ Moved under <code class="prettyprint">footnotes\includes</code> namespace.</p>
</article>
<article class="phpdocumentor-element -constant -public -deprecated">
<h4 class="phpdocumentor-element__name" id="constant_C_STR_NO_LOVE_SLUG">
C_STR_NO_LOVE_SLUG
<a href="classes/footnotes-includes-Config.html#constant_C_STR_NO_LOVE_SLUG" class="headerlink"><i class="fas fa-link"></i></a>
<h4 class="phpdocumentor-element__name" id="constant_NO_LOVE_SLUG">
NO_LOVE_SLUG
<a href="classes/footnotes-includes-Config.html#constant_NO_LOVE_SLUG" 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/includes/class-config.php"><a href="files/src-includes-class-config.html"><abbr title="src/includes/class-config.php">class-config.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">106</span>
<span class="phpdocumentor-element-found-in__line">108</span>
</aside>
<p class="phpdocumentor-summary">Shortcode to NOT display the ‘LOVE ME’ slug on certain pages.</p>
@ -335,7 +349,7 @@ Moved under <code class="prettyprint">footnotes\includes</code> namespace.</p>
<code class="phpdocumentor-signature phpdocumentor-code -deprecated">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">C_STR_NO_LOVE_SLUG</span>
<span class="phpdocumentor-signature__name">NO_LOVE_SLUG</span>
= <span class="phpdocumentor-signature__default-value">&#039;[[no footnotes: love]]&#039;</span>
</code>
@ -378,15 +392,15 @@ Moved under <code class="prettyprint">footnotes\includes</code> namespace.</p>
</article>
<article class="phpdocumentor-element -constant -public -deprecated">
<h4 class="phpdocumentor-element__name" id="constant_C_STR_PLUGIN_HEADING_NAME">
C_STR_PLUGIN_HEADING_NAME
<a href="classes/footnotes-includes-Config.html#constant_C_STR_PLUGIN_HEADING_NAME" class="headerlink"><i class="fas fa-link"></i></a>
<h4 class="phpdocumentor-element__name" id="constant_PLUGIN_HEADING_NAME">
PLUGIN_HEADING_NAME
<a href="classes/footnotes-includes-Config.html#constant_PLUGIN_HEADING_NAME" 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/includes/class-config.php"><a href="files/src-includes-class-config.html"><abbr title="src/includes/class-config.php">class-config.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">73</span>
<span class="phpdocumentor-element-found-in__line">75</span>
</aside>
<p class="phpdocumentor-summary">Public plugin name for use as a dashboard heading.</p>
@ -394,7 +408,7 @@ Moved under <code class="prettyprint">footnotes\includes</code> namespace.</p>
<code class="phpdocumentor-signature phpdocumentor-code -deprecated">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">C_STR_PLUGIN_HEADING_NAME</span>
<span class="phpdocumentor-signature__name">PLUGIN_HEADING_NAME</span>
= <span class="phpdocumentor-signature__default-value">&#039;&lt;span class=&quot;footnotes_logo_heading footnotes_logo_part1_heading&quot;&gt;foot&lt;/span&gt;&lt;span class=&quot;footnotes_logo_heading footnotes_logo_part2_heading&quot;&gt;notes&lt;/span&gt;&#039;</span>
</code>
@ -442,15 +456,15 @@ that isn't translated, and dropping the logo in another, translatable heading.</
</article>
<article class="phpdocumentor-element -constant -public -deprecated">
<h4 class="phpdocumentor-element__name" id="constant_C_STR_PLUGIN_PUBLIC_NAME">
C_STR_PLUGIN_PUBLIC_NAME
<a href="classes/footnotes-includes-Config.html#constant_C_STR_PLUGIN_PUBLIC_NAME" class="headerlink"><i class="fas fa-link"></i></a>
<h4 class="phpdocumentor-element__name" id="constant_PLUGIN_PUBLIC_NAME">
PLUGIN_PUBLIC_NAME
<a href="classes/footnotes-includes-Config.html#constant_PLUGIN_PUBLIC_NAME" 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/includes/class-config.php"><a href="files/src-includes-class-config.html"><abbr title="src/includes/class-config.php">class-config.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">56</span>
<span class="phpdocumentor-element-found-in__line">58</span>
</aside>
<p class="phpdocumentor-summary">Public plugin name.</p>
@ -458,7 +472,7 @@ that isn't translated, and dropping the logo in another, translatable heading.</
<code class="phpdocumentor-signature phpdocumentor-code -deprecated">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">C_STR_PLUGIN_PUBLIC_NAME</span>
<span class="phpdocumentor-signature__name">PLUGIN_PUBLIC_NAME</span>
= <span class="phpdocumentor-signature__default-value">&#039;&lt;span class=&quot;footnotes_logo footnotes_logo_part1&quot;&gt;foot&lt;/span&gt;&lt;span class=&quot;footnotes_logo footnotes_logo_part2&quot;&gt;notes&lt;/span&gt;&#039;</span>
</code>

89
docs/classes/footnotes-includes-Convert.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
@ -84,6 +92,12 @@
Convert
<div class="phpdocumentor-element__package">
in package
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="packages/Default.html">Default</a></li>
</ul>
</div>
</h2>
@ -91,7 +105,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-convert.php"><a href="files/src-includes-class-convert.html"><abbr title="src/includes/class-convert.php">class-convert.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">18</span>
<span class="phpdocumentor-element-found-in__line">20</span>
</aside>
<p class="phpdocumentor-summary">Class providing variable type and value conversion functions.</p>
@ -129,14 +143,14 @@
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-Convert.html#method_debug">debug()</a>
<span>
&nbsp;: mixed </span>
&nbsp;: void </span>
</dt>
<dd>Displays a variable.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-Convert.html#method_get_arrow">get_arrow()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;|string </span>
&nbsp;: string|array&lt;string|int, string&gt; </span>
</dt>
<dd>Get an HTML array short code depending on Arrow-Array key index.</dd>
@ -169,7 +183,7 @@
<dd>Converts an integer into Latin ASCII characters, either lower or upper-case.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/footnotes-includes-Convert.html#method_to_romanic">to_romanic()</a>
<a href="classes/footnotes-includes-Convert.html#method_to_roman">to_roman()</a>
<span>
&nbsp;: string </span>
</dt>
@ -201,14 +215,14 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-convert.php"><a href="files/src-includes-class-convert.html"><abbr title="src/includes/class-convert.php">class-convert.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">203</span>
<span class="phpdocumentor-element-found-in__line">112</span>
</aside>
<p class="phpdocumentor-summary">Displays a variable.</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__name">debug</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_mixed_value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">debug</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_mixed_value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
@ -252,7 +266,7 @@
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
@ -271,21 +285,21 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-convert.php"><a href="files/src-includes-class-convert.html"><abbr title="src/includes/class-convert.php">class-convert.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">179</span>
<span class="phpdocumentor-element-found-in__line">84</span>
</aside>
<p class="phpdocumentor-summary">Get an HTML array short code depending on Arrow-Array key index.</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__name">get_arrow</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_int_index</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">-1</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|string</span></code>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">get_arrow</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$index</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">-1</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|array&lt;string|int, string&gt;</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">$p_int_index</span>
<span class="phpdocumentor-signature__argument__name">$index</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">-1</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
@ -318,11 +332,20 @@
<section class="phpdocumentor-description"><p>Review.</p>
</section>
</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>Single return type.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;|string</span>
<span class="phpdocumentor-signature__response_type">string|array&lt;string|int, string&gt;</span>
&mdash;
<section class="phpdocumentor-description"><p>Array of all arrows if index is empty, otherwise HTML tag of a specific arrow.</p>
</section>
@ -342,21 +365,21 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-convert.php"><a href="files/src-includes-class-convert.html"><abbr title="src/includes/class-convert.php">class-convert.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">Converts an integer into the user-defined counter style for the footnotes.</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__name">index</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_int_index</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_convert_style</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;arabic_plain&#039;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">index</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$index</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$convert_style</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;arabic_plain&#039;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</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">$p_int_index</span>
<span class="phpdocumentor-signature__argument__name">$index</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
@ -365,7 +388,7 @@
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_convert_style</span>
<span class="phpdocumentor-signature__argument__name">$convert_style</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">&#039;arabic_plain&#039;</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
@ -395,7 +418,7 @@
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"><p>Converted Index converted to the defined counter style.</p>
<section class="phpdocumentor-description"><p>The index converted to the defined counter style.</p>
</section>
@ -413,21 +436,21 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-convert.php"><a href="files/src-includes-class-convert.html"><abbr title="src/includes/class-convert.php">class-convert.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">154</span>
<span class="phpdocumentor-element-found-in__line">58</span>
</aside>
<p class="phpdocumentor-summary">Converts a string depending on its value to a boolean.</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__name">to_bool</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">to_bool</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</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">$p_str_value</span>
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
@ -484,21 +507,21 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-convert.php"><a href="files/src-includes-class-convert.html"><abbr title="src/includes/class-convert.php">class-convert.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">92</span>
<span class="phpdocumentor-element-found-in__line">180</span>
</aside>
<p class="phpdocumentor-summary">Converts an integer to a leading-0 integer.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">to_arabic_leading</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_int_value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">to_arabic_leading</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</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">$p_int_value</span>
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
@ -555,14 +578,14 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-convert.php"><a href="files/src-includes-class-convert.html"><abbr title="src/includes/class-convert.php">class-convert.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">60</span>
<span class="phpdocumentor-element-found-in__line">149</span>
</aside>
<p class="phpdocumentor-summary">Converts an integer into Latin ASCII characters, either lower or upper-case.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">to_latin</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_int_value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_bool_upper_case</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">to_latin</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$upper_case</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"><p>This function works from values A–ZZ (meaning there is a limit of 676
gootnotes per Page).</p>
@ -571,7 +594,7 @@ gootnotes per Page).</p>
<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">$p_int_value</span>
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
@ -580,7 +603,7 @@ gootnotes per Page).</p>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_bool_upper_case</span>
<span class="phpdocumentor-signature__argument__name">$upper_case</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
@ -629,28 +652,28 @@ gootnotes per Page).</p>
-private
-static "
>
<h4 class="phpdocumentor-element__name" id="method_to_romanic">
to_romanic()
<a href="classes/footnotes-includes-Convert.html#method_to_romanic" class="headerlink"><i class="fas fa-link"></i></a>
<h4 class="phpdocumentor-element__name" id="method_to_roman">
to_roman()
<a href="classes/footnotes-includes-Convert.html#method_to_roman" 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/includes/class-convert.php"><a href="files/src-includes-class-convert.html"><abbr title="src/includes/class-convert.php">class-convert.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">109</span>
<span class="phpdocumentor-element-found-in__line">195</span>
</aside>
<p class="phpdocumentor-summary">Converts an integer to a Roman numeral.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">to_romanic</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_int_value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_bool_upper_case</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">to_roman</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$upper_case</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</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">$p_int_value</span>
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
@ -659,7 +682,7 @@ gootnotes per Page).</p>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_bool_upper_case</span>
<span class="phpdocumentor-signature__argument__name">$upper_case</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">

40
docs/classes/footnotes-includes-Core.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
@ -84,6 +92,12 @@
Core
<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>
</h2>
@ -91,7 +105,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-core.php"><a href="files/src-includes-class-core.html"><abbr title="src/includes/class-core.php">class-core.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">46</span>
<span class="phpdocumentor-element-found-in__line">48</span>
</aside>
<p class="phpdocumentor-summary">Class providing core plugin functionality.</p>
@ -255,7 +269,7 @@ the plugin.</dd>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-core.php"><a href="files/src-includes-class-core.html"><abbr title="src/includes/class-core.php">class-core.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">55</span>
<span class="phpdocumentor-element-found-in__line">57</span>
</aside>
<p class="phpdocumentor-summary">The loader that&#039;s responsible for maintaining and registering all hooks
@ -303,7 +317,7 @@ that power the plugin.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-core.php"><a href="files/src-includes-class-core.html"><abbr title="src/includes/class-core.php">class-core.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">64</span>
<span class="phpdocumentor-element-found-in__line">66</span>
</aside>
<p class="phpdocumentor-summary">The unique identifier of this plugin</p>
@ -350,7 +364,7 @@ that power the plugin.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-core.php"><a href="files/src-includes-class-core.html"><abbr title="src/includes/class-core.php">class-core.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">74</span>
<span class="phpdocumentor-element-found-in__line">76</span>
</aside>
<p class="phpdocumentor-summary">The current version of the plugin.</p>
@ -410,7 +424,7 @@ that power the plugin.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-core.php"><a href="files/src-includes-class-core.html"><abbr title="src/includes/class-core.php">class-core.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">88</span>
<span class="phpdocumentor-element-found-in__line">90</span>
</aside>
<p class="phpdocumentor-summary">Builds the core of the plugin.</p>
@ -471,7 +485,7 @@ the admin area and the public-facing side of the site.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-core.php"><a href="files/src-includes-class-core.html"><abbr title="src/includes/class-core.php">class-core.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">256</span>
<span class="phpdocumentor-element-found-in__line">126</span>
</aside>
<p class="phpdocumentor-summary">Returns a reference to the class that orchestrates the hooks with the plugin.</p>
@ -520,7 +534,7 @@ the admin area and the public-facing side of the site.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-core.php"><a href="files/src-includes-class-core.html"><abbr title="src/includes/class-core.php">class-core.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">247</span>
<span class="phpdocumentor-element-found-in__line">117</span>
</aside>
<p class="phpdocumentor-summary">Gets the name of the plugin used to uniquely identify it within the
@ -570,7 +584,7 @@ context of WordPress and to define internationalization functionality.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-core.php"><a href="files/src-includes-class-core.html"><abbr title="src/includes/class-core.php">class-core.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">265</span>
<span class="phpdocumentor-element-found-in__line">135</span>
</aside>
<p class="phpdocumentor-summary">Gets the version number of the plugin.</p>
@ -619,7 +633,7 @@ context of WordPress and to define internationalization functionality.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-core.php"><a href="files/src-includes-class-core.html"><abbr title="src/includes/class-core.php">class-core.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">237</span>
<span class="phpdocumentor-element-found-in__line">107</span>
</aside>
<p class="phpdocumentor-summary">Runs the loader to execute all of the hooks with WordPress.</p>
@ -668,7 +682,7 @@ context of WordPress and to define internationalization functionality.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-core.php"><a href="files/src-includes-class-core.html"><abbr title="src/includes/class-core.php">class-core.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">189</span>
<span class="phpdocumentor-element-found-in__line">223</span>
</aside>
<p class="phpdocumentor-summary">Register all of the hooks related to the admin area functionality of the
@ -738,7 +752,7 @@ plugin.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-core.php"><a href="files/src-includes-class-core.html"><abbr title="src/includes/class-core.php">class-core.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">220</span>
<span class="phpdocumentor-element-found-in__line">253</span>
</aside>
<p class="phpdocumentor-summary">Register all of the hooks related to the public-facing functionality of
@ -798,7 +812,7 @@ the plugin.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-core.php"><a href="files/src-includes-class-core.html"><abbr title="src/includes/class-core.php">class-core.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">123</span>
<span class="phpdocumentor-element-found-in__line">159</span>
</aside>
<p class="phpdocumentor-summary">Load the required dependencies for this plugin.</p>
@ -868,7 +882,7 @@ with WordPress.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-core.php"><a href="files/src-includes-class-core.html"><abbr title="src/includes/class-core.php">class-core.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">171</span>
<span class="phpdocumentor-element-found-in__line">206</span>
</aside>
<p class="phpdocumentor-summary">Define the locale for this plugin for internationalization.</p>

24
docs/classes/footnotes-includes-Deactivator.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
@ -84,6 +92,12 @@
Deactivator
<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>
</h2>
@ -91,7 +105,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-deactivator.php"><a href="files/src-includes-class-deactivator.html"><abbr title="src/includes/class-deactivator.php">class-deactivator.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">19</span>
<span class="phpdocumentor-element-found-in__line">21</span>
</aside>
<p class="phpdocumentor-summary">Class providing action(s) on plugin deactivation.</p>
@ -130,7 +144,7 @@
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-Deactivator.html#method_deactivate">deactivate()</a>
<span>
&nbsp;: mixed </span>
&nbsp;: void </span>
</dt>
<dd>Runs when the plugin is deactivated.</dd>
@ -160,14 +174,14 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-deactivator.php"><a href="files/src-includes-class-deactivator.html"><abbr title="src/includes/class-deactivator.php">class-deactivator.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">28</span>
<span class="phpdocumentor-element-found-in__line">32</span>
</aside>
<p class="phpdocumentor-summary">Runs when the plugin is deactivated.</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__name">deactivate</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">deactivate</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>Currently NOP.</p>
</section>
@ -191,7 +205,7 @@
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>

157
docs/classes/footnotes-includes-Loader.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
@ -84,6 +92,12 @@
Loader
<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>
</h2>
@ -91,7 +105,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-loader.php"><a href="files/src-includes-class-loader.html"><abbr title="src/includes/class-loader.php">class-loader.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">23</span>
<span class="phpdocumentor-element-found-in__line">25</span>
</aside>
<p class="phpdocumentor-summary">Class defining action/filter registration for the plugin.</p>
@ -146,35 +160,35 @@ list of actions and filters.</p>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-Loader.html#method___construct">__construct()</a>
<span>
&nbsp;: mixed </span>
&nbsp;: void </span>
</dt>
<dd>Initialize the collections used to maintain the actions and filters.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-Loader.html#method_add_action">add_action()</a>
<span>
&nbsp;: mixed </span>
&nbsp;: void </span>
</dt>
<dd>Add a new action to the collection to be registered with WordPress.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-Loader.html#method_add_filter">add_filter()</a>
<span>
&nbsp;: mixed </span>
&nbsp;: void </span>
</dt>
<dd>Add a new filter to the collection to be registered with WordPress.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-Loader.html#method_run">run()</a>
<span>
&nbsp;: mixed </span>
&nbsp;: void </span>
</dt>
<dd>Registers the filters and actions with WordPress.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/footnotes-includes-Loader.html#method_add">add()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
&nbsp;: array&lt;string|int, array&lt;string|int, string|int|object&gt;&gt; </span>
</dt>
<dd>A utility function that is used to register the actions and hooks into a single
collection.</dd>
@ -207,7 +221,7 @@ collection.</dd>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-loader.php"><a href="files/src-includes-class-loader.html"><abbr title="src/includes/class-loader.php">class-loader.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">32</span>
<span class="phpdocumentor-element-found-in__line">34</span>
</aside>
<p class="phpdocumentor-summary">The array of actions registered with WordPress.</p>
@ -227,15 +241,6 @@ collection.</dd>
</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>protected</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
@ -243,6 +248,16 @@ collection.</dd>
<section class="phpdocumentor-description"></section>
</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"><a href="classes/footnotes-includes-Loader.html#method_add"><abbr title="\footnotes\includes\Loader::add()">Loader::add()</abbr></a></span>
<section class="phpdocumentor-description"><p>For more information on the hook array format.</p>
</section>
</dd>
</dl>
@ -263,7 +278,7 @@ collection.</dd>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-loader.php"><a href="files/src-includes-class-loader.html"><abbr title="src/includes/class-loader.php">class-loader.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">42</span>
<span class="phpdocumentor-element-found-in__line">44</span>
</aside>
<p class="phpdocumentor-summary">The array of filters registered with WordPress.</p>
@ -283,15 +298,6 @@ collection.</dd>
</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>protected</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
@ -299,6 +305,16 @@ collection.</dd>
<section class="phpdocumentor-description"></section>
</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"><a href="classes/footnotes-includes-Loader.html#method_add"><abbr title="\footnotes\includes\Loader::add()">Loader::add()</abbr></a></span>
<section class="phpdocumentor-description"><p>For more information on the hook array format.</p>
</section>
</dd>
</dl>
@ -323,14 +339,14 @@ collection.</dd>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-loader.php"><a href="files/src-includes-class-loader.html"><abbr title="src/includes/class-loader.php">class-loader.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">49</span>
<span class="phpdocumentor-element-found-in__line">53</span>
</aside>
<p class="phpdocumentor-summary">Initialize the collections used to maintain the actions and filters.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
@ -353,7 +369,7 @@ collection.</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
@ -372,14 +388,14 @@ collection.</dd>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-loader.php"><a href="files/src-includes-class-loader.html"><abbr title="src/includes/class-loader.php">class-loader.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">67</span>
<span class="phpdocumentor-element-found-in__line">73</span>
</aside>
<p class="phpdocumentor-summary">Add a new action to the collection to be registered with WordPress.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">add_action</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$hook</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">object&nbsp;</span><span class="phpdocumentor-signature__argument__name">$component</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">$callback</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$priority</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">10</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$accepted_args</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">1</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<span class="phpdocumentor-signature__name">add_action</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$hook</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">object&nbsp;</span><span class="phpdocumentor-signature__argument__name">$component</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">$callback</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$priority</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">10</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$accepted_args</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">1</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
@ -417,7 +433,7 @@ collection.</dd>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">10</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>(optional) The priority at which the function should be fired. Default is 10.</p>
<section class="phpdocumentor-description"><p>Optional. The priority at which the function should be fired. Default is 10.</p>
</section>
</dd>
@ -426,7 +442,7 @@ collection.</dd>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">1</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>(optional) The number of arguments that should be passed to the $callback. Default is 1.</p>
<section class="phpdocumentor-description"><p>Optional. The number of arguments that should be passed to the $callback. Default is 1.</p>
</section>
</dd>
@ -446,11 +462,21 @@ collection.</dd>
<section class="phpdocumentor-description"></section>
</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"><a href="classes/footnotes-includes-Loader.html#method_add"><abbr title="\footnotes\includes\Loader::add()">Loader::add()</abbr></a></span>
<section class="phpdocumentor-description"><p>For more information on the hook array format.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
@ -469,14 +495,14 @@ collection.</dd>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-loader.php"><a href="files/src-includes-class-loader.html"><abbr title="src/includes/class-loader.php">class-loader.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">82</span>
<span class="phpdocumentor-element-found-in__line">90</span>
</aside>
<p class="phpdocumentor-summary">Add a new filter to the collection to be registered with WordPress.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">add_filter</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$hook</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">object&nbsp;</span><span class="phpdocumentor-signature__argument__name">$component</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">$callback</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$priority</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">10</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$accepted_args</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">1</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<span class="phpdocumentor-signature__name">add_filter</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$hook</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">object&nbsp;</span><span class="phpdocumentor-signature__argument__name">$component</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">$callback</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$priority</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">10</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$accepted_args</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">1</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
@ -514,7 +540,7 @@ collection.</dd>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">10</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>(optional) The priority at which the function should be fired. Default is 10.</p>
<section class="phpdocumentor-description"><p>Optional. The priority at which the function should be fired. Default is 10.</p>
</section>
</dd>
@ -523,7 +549,7 @@ collection.</dd>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">1</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>(optional) The number of arguments that should be passed to the $callback. Default is 1.</p>
<section class="phpdocumentor-description"><p>Optional. The number of arguments that should be passed to the $callback. Default is 1.</p>
</section>
</dd>
@ -543,11 +569,21 @@ collection.</dd>
<section class="phpdocumentor-description"></section>
</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"><a href="classes/footnotes-includes-Loader.html#method_add"><abbr title="\footnotes\includes\Loader::add()">Loader::add()</abbr></a></span>
<section class="phpdocumentor-description"><p>For more information on the hook array format.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
@ -566,14 +602,14 @@ collection.</dd>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-loader.php"><a href="files/src-includes-class-loader.html"><abbr title="src/includes/class-loader.php">class-loader.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">120</span>
<span class="phpdocumentor-element-found-in__line">102</span>
</aside>
<p class="phpdocumentor-summary">Registers the filters and actions with WordPress.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">run</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<span class="phpdocumentor-signature__name">run</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
@ -592,11 +628,21 @@ collection.</dd>
<section class="phpdocumentor-description"></section>
</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"><a href="classes/footnotes-includes-Loader.html#method_add"><abbr title="\footnotes\includes\Loader::add()">Loader::add()</abbr></a></span>
<section class="phpdocumentor-description"><p>For more information on the hook array format.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
@ -615,7 +661,7 @@ collection.</dd>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-loader.php"><a href="files/src-includes-class-loader.html"><abbr title="src/includes/class-loader.php">class-loader.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">101</span>
<span class="phpdocumentor-element-found-in__line">135</span>
</aside>
<p class="phpdocumentor-summary">A utility function that is used to register the actions and hooks into a single
@ -623,7 +669,7 @@ collection.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">add</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$hooks</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">$hook</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">object&nbsp;</span><span class="phpdocumentor-signature__argument__name">$component</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">$callback</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$priority</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$accepted_args</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
<span class="phpdocumentor-signature__name">add</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, array&lt;string|int, string|int|object&gt;&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$hooks</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">$hook</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">object&nbsp;</span><span class="phpdocumentor-signature__argument__name">$component</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">$callback</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$priority</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$accepted_args</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, array&lt;string|int, string|int|object&gt;&gt;</span></code>
<section class="phpdocumentor-description"></section>
@ -631,7 +677,7 @@ collection.</p>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$hooks</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, array&lt;string|int, string|int|object&gt;&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The collection of hooks that is being registered (that is, actions or filters).</p>
@ -692,15 +738,6 @@ collection.</p>
</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>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
@ -712,9 +749,17 @@ collection.</p>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, array&lt;string|int, string|int|object&gt;&gt;</span>
&mdash;
<section class="phpdocumentor-description"><p>The collection of actions and filters registered with WordPress.</p>
<section class="phpdocumentor-description"><p>{
The registered hook(s).</p>
<pre class="prettyprint"><code class="prettyprint">@type string $hook The name of the registered WordPress hook.
@type object $component A reference to the instance of the object on which the hook is defined.
@type string $callback The name of the function definition on the `$component`.
@type int $priority The priority at which the function should be fired.
@type int $accepted_args The number of arguments that should be passed to the `$callback`.
</code></pre>
<p>}</p>
</section>

4397
docs/classes/footnotes-includes-Settings.html
View file

File diff suppressed because it is too large Load diff

122
docs/classes/footnotes-includes-Template.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
@ -84,6 +92,13 @@
Template
<div class="phpdocumentor-element__package">
in package
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="packages/footnotes.html">footnotes</a></li>
<li class="phpdocumentor-breadcrumb"><a href="packages/footnotes-includes.html">includes</a></li>
</ul>
</div>
</h2>
@ -91,7 +106,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-template.php"><a href="files/src-includes-class-template.html"><abbr title="src/includes/class-template.php">class-template.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">28</span>
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<p class="phpdocumentor-summary">Class defining template rendering.</p>
@ -147,14 +162,14 @@ file content.</p>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/footnotes-includes-Template.html#constant_C_STR_DASHBOARD">C_STR_DASHBOARD</a>
<a href="classes/footnotes-includes-Template.html#constant_DASHBOARD">DASHBOARD</a>
<span>
&nbsp;= &#039;admin/partials&#039; </span>
</dt>
<dd>Directory name for dashboard partials.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/footnotes-includes-Template.html#constant_C_STR_PUBLIC">C_STR_PUBLIC</a>
<a href="classes/footnotes-includes-Template.html#constant_PUBLIC">PUBLIC</a>
<span>
&nbsp;= &#039;public/partials&#039; </span>
</dt>
@ -168,14 +183,14 @@ file content.</p>
<dd>Plugin Directory</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/footnotes-includes-Template.html#property_a_str_original_content">$a_str_original_content</a>
<a href="classes/footnotes-includes-Template.html#property_original_content">$original_content</a>
<span>
&nbsp;: string </span>
&nbsp;: string|null </span>
</dt>
<dd>Contains the content of the template after initialize.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/footnotes-includes-Template.html#property_a_str_replaced_content">$a_str_replaced_content</a>
<a href="classes/footnotes-includes-Template.html#property_replaced_content">$replaced_content</a>
<span>
&nbsp;: string </span>
</dt>
@ -184,7 +199,7 @@ file content.</p>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-Template.html#method___construct">__construct()</a>
<span>
&nbsp;: mixed </span>
&nbsp;: void </span>
</dt>
<dd>Class Constructor. Reads and loads the template file without replace any placeholder.</dd>
@ -198,7 +213,7 @@ file content.</p>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-Template.html#method_get_template">get_template()</a>
<span>
&nbsp;: mixed </span>
&nbsp;: string|bool </span>
</dt>
<dd>Get the template.</dd>
@ -212,7 +227,7 @@ file content.</p>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-Template.html#method_reload">reload()</a>
<span>
&nbsp;: mixed </span>
&nbsp;: void </span>
</dt>
<dd>Reloads the original content of the template file.</dd>
@ -234,15 +249,15 @@ file content.</p>
<a href="classes/footnotes-includes-Template.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_C_STR_DASHBOARD">
C_STR_DASHBOARD
<a href="classes/footnotes-includes-Template.html#constant_C_STR_DASHBOARD" class="headerlink"><i class="fas fa-link"></i></a>
<h4 class="phpdocumentor-element__name" id="constant_DASHBOARD">
DASHBOARD
<a href="classes/footnotes-includes-Template.html#constant_DASHBOARD" 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/includes/class-template.php"><a href="files/src-includes-class-template.html"><abbr title="src/includes/class-template.php">class-template.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">37</span>
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Directory name for dashboard partials.</p>
@ -250,7 +265,7 @@ file content.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">C_STR_DASHBOARD</span>
<span class="phpdocumentor-signature__name">DASHBOARD</span>
= <span class="phpdocumentor-signature__default-value">&#039;admin/partials&#039;</span>
</code>
@ -276,15 +291,15 @@ file content.</p>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_C_STR_PUBLIC">
C_STR_PUBLIC
<a href="classes/footnotes-includes-Template.html#constant_C_STR_PUBLIC" class="headerlink"><i class="fas fa-link"></i></a>
<h4 class="phpdocumentor-element__name" id="constant_PUBLIC">
PUBLIC
<a href="classes/footnotes-includes-Template.html#constant_PUBLIC" 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/includes/class-template.php"><a href="files/src-includes-class-template.html"><abbr title="src/includes/class-template.php">class-template.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">46</span>
<span class="phpdocumentor-element-found-in__line">48</span>
</aside>
<p class="phpdocumentor-summary">Directory name for public partials.</p>
@ -292,7 +307,7 @@ file content.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">C_STR_PUBLIC</span>
<span class="phpdocumentor-signature__name">PUBLIC</span>
= <span class="phpdocumentor-signature__default-value">&#039;public/partials&#039;</span>
</code>
@ -341,7 +356,7 @@ file content.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-template.php"><a href="files/src-includes-class-template.html"><abbr title="src/includes/class-template.php">class-template.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">73</span>
<span class="phpdocumentor-element-found-in__line">54</span>
</aside>
<p class="phpdocumentor-summary">Plugin Directory</p>
@ -379,24 +394,24 @@ file content.</p>
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_a_str_original_content">
$a_str_original_content
<a href="classes/footnotes-includes-Template.html#property_a_str_original_content" class="headerlink"><i class="fas fa-link"></i></a>
<h4 class="phpdocumentor-element__name" id="property_original_content">
$original_content
<a href="classes/footnotes-includes-Template.html#property_original_content" 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/includes/class-template.php"><a href="files/src-includes-class-template.html"><abbr title="src/includes/class-template.php">class-template.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">55</span>
<span class="phpdocumentor-element-found-in__line">61</span>
</aside>
<p class="phpdocumentor-summary">Contains the content of the template after initialize.</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">$a_str_original_content</span>
<span class="phpdocumentor-signature__type">string|null</span>
<span class="phpdocumentor-signature__name">$original_content</span>
= <span class="phpdocumentor-signature__default-value">&#039;&#039;</span></code>
<section class="phpdocumentor-description"></section>
@ -426,16 +441,16 @@ file content.</p>
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_a_str_replaced_content">
$a_str_replaced_content
<a href="classes/footnotes-includes-Template.html#property_a_str_replaced_content" class="headerlink"><i class="fas fa-link"></i></a>
<h4 class="phpdocumentor-element__name" id="property_replaced_content">
$replaced_content
<a href="classes/footnotes-includes-Template.html#property_replaced_content" 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/includes/class-template.php"><a href="files/src-includes-class-template.html"><abbr title="src/includes/class-template.php">class-template.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">64</span>
<span class="phpdocumentor-element-found-in__line">68</span>
</aside>
<p class="phpdocumentor-summary">Contains the content of the template after initialize with replaced place holders.</p>
@ -443,7 +458,7 @@ file content.</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">$a_str_replaced_content</span>
<span class="phpdocumentor-signature__name">$replaced_content</span>
= <span class="phpdocumentor-signature__default-value">&#039;&#039;</span></code>
<section class="phpdocumentor-description"></section>
@ -486,21 +501,21 @@ file content.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-template.php"><a href="files/src-includes-class-template.html"><abbr title="src/includes/class-template.php">class-template.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">85</span>
<span class="phpdocumentor-element-found-in__line">81</span>
</aside>
<p class="phpdocumentor-summary">Class Constructor. Reads and loads the template file without replace any placeholder.</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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_file_type</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">$p_str_file_name</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_extension</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;html&#039;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<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">$file_type</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">$file_name</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$extension</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;html&#039;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</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">$p_str_file_type</span>
<span class="phpdocumentor-signature__argument__name">$file_type</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
@ -509,7 +524,7 @@ file content.</p>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_file_name</span>
<span class="phpdocumentor-signature__argument__name">$file_name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
@ -518,7 +533,7 @@ file content.</p>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_extension</span>
<span class="phpdocumentor-signature__argument__name">$extension</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">&#039;html&#039;</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
@ -555,7 +570,7 @@ file content.</p>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
@ -633,21 +648,21 @@ file content.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-template.php"><a href="files/src-includes-class-template.html"><abbr title="src/includes/class-template.php">class-template.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">183</span>
<span class="phpdocumentor-element-found-in__line">184</span>
</aside>
<p class="phpdocumentor-summary">Get the template.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">get_template</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_file_type</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">$p_str_file_name</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_extension</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;html&#039;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<span class="phpdocumentor-signature__name">get_template</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$file_type</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">$file_name</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$extension</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;html&#039;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|bool</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">$p_str_file_type</span>
<span class="phpdocumentor-signature__argument__name">$file_type</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
@ -656,7 +671,7 @@ file content.</p>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_file_name</span>
<span class="phpdocumentor-signature__argument__name">$file_name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
@ -665,7 +680,7 @@ file content.</p>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_extension</span>
<span class="phpdocumentor-signature__argument__name">$extension</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">&#039;html&#039;</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
@ -698,11 +713,20 @@ file content.</p>
<section class="phpdocumentor-description"><p>Refactor templating.</p>
</section>
</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>Single return type.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
<span class="phpdocumentor-signature__response_type">string|bool</span>
&mdash;
<section class="phpdocumentor-description"><p><code class="prettyprint">false</code> or the template path</p>
</section>
@ -799,7 +823,7 @@ file content.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">reload</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<span class="phpdocumentor-signature__name">reload</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
@ -831,7 +855,7 @@ file content.</p>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
@ -850,22 +874,22 @@ file content.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-template.php"><a href="files/src-includes-class-template.html"><abbr title="src/includes/class-template.php">class-template.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">111</span>
<span class="phpdocumentor-element-found-in__line">109</span>
</aside>
<p class="phpdocumentor-summary">Replace all placeholders specified in array.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">replace</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_arr_placeholders</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<span class="phpdocumentor-signature__name">replace</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, string&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$placeholders</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</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">$p_arr_placeholders</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__argument__name">$placeholders</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, string&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Placeholders (key = placeholder, value = value).</p>

26
docs/classes/footnotes-includes-i18n.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
@ -84,6 +92,12 @@
i18n
<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>
</h2>
@ -91,7 +105,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-i18n.php"><a href="files/src-includes-class-i18n.html"><abbr title="src/includes/class-i18n.php">class-i18n.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Class providing internationalization functionality.</p>
@ -149,7 +163,7 @@ is ready for translation.</p>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-i18n.html#method_load_plugin_textdomain">load_plugin_textdomain()</a>
<span>
&nbsp;: mixed </span>
&nbsp;: void </span>
</dt>
<dd>Load the plugin text domain for translation.</dd>
@ -179,14 +193,14 @@ is ready for translation.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-i18n.php"><a href="files/src-includes-class-i18n.html"><abbr title="src/includes/class-i18n.php">class-i18n.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">35</span>
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Load the plugin text domain for translation.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">load_plugin_textdomain</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<span class="phpdocumentor-signature__name">load_plugin_textdomain</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
@ -212,14 +226,14 @@ is ready for translation.</p>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
<section class="phpdocumentor-description"><p>Rename from <code class="prettyprint">load()</code> to <code class="prettyprint">load_plugin_textdomain()</code>. Remove unused <code class="prettyprint">$p_str_language_code</code> parameter.</p>
<section class="phpdocumentor-description"><p>Rename from <code class="prettyprint">load()</code> to <code class="prettyprint">load_plugin_textdomain()</code>. Remove unused <code class="prettyprint">$language_code</code> parameter.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>

8
docs/files/src-admin-class-admin.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

8
docs/files/src-admin-class-wysiwyg.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

8
docs/files/src-admin-layout-class-engine.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

8
docs/files/src-admin-layout-class-init.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

8
docs/files/src-admin-layout-class-settings.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

12
docs/files/src-footnotes.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
@ -177,7 +185,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/footnotes.php"><a href="files/src-footnotes.html"><abbr title="src/footnotes.php">footnotes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">86</span>
<span class="phpdocumentor-element-found-in__line">84</span>
</aside>
<p class="phpdocumentor-summary">Handles the deactivation of the plugin.</p>
@ -225,7 +233,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/footnotes.php"><a href="files/src-footnotes.html"><abbr title="src/footnotes.php">footnotes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">114</span>
<span class="phpdocumentor-element-found-in__line">117</span>
</aside>
<p class="phpdocumentor-summary">Begins execution of the plugin.</p>

8
docs/files/src-includes-class-activator.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

8
docs/files/src-includes-class-config.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

8
docs/files/src-includes-class-convert.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

8
docs/files/src-includes-class-core.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

8
docs/files/src-includes-class-deactivator.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

8
docs/files/src-includes-class-i18n.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

8
docs/files/src-includes-class-loader.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

8
docs/files/src-includes-class-settings.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

8
docs/files/src-includes-class-template.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

8
docs/files/src-public-class-general.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

8
docs/files/src-public-class-parser.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

8
docs/files/src-public-widget-class-base.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

8
docs/files/src-public-widget-class-reference-container.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

8
docs/files/src-uninstall.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

8
docs/graphs/classes.html
View file

@ -52,6 +52,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

19
docs/index.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
@ -77,7 +85,16 @@
<h2>Documentation</h2>
<h3 id="packages">
Packages
<a href="#packages" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></dt>
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></dt>
</dl>
<h3 id="namespaces">
Namespaces
<a href="#namespaces" class="headerlink"><i class="fas fa-link"></i></a>

8
docs/indices/files.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

1632
docs/js/searchIndex.js
View file

File diff suppressed because it is too large Load diff

8
docs/namespaces/default.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

8
docs/namespaces/footnotes-admin-layout.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

8
docs/namespaces/footnotes-admin.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

8
docs/namespaces/footnotes-general-widget.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

8
docs/namespaces/footnotes-general.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

8
docs/namespaces/footnotes-includes.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

12
docs/namespaces/footnotes.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
@ -186,7 +194,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/footnotes.php"><a href="files/src-footnotes.html"><abbr title="src/footnotes.php">footnotes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">86</span>
<span class="phpdocumentor-element-found-in__line">84</span>
</aside>
<p class="phpdocumentor-summary">Handles the deactivation of the plugin.</p>
@ -234,7 +242,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/footnotes.php"><a href="files/src-footnotes.html"><abbr title="src/footnotes.php">footnotes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">114</span>
<span class="phpdocumentor-element-found-in__line">117</span>
</aside>
<p class="phpdocumentor-summary">Begins execution of the plugin.</p>

189
docs/packages/Default.html
View file

@ -61,12 +61,11 @@
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-admin.html"><abbr title="\footnotes\admin">admin</abbr></a></li>
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
@ -91,12 +90,194 @@
<h3 id="interfaces_class_traits">
Interfaces, Classes and Traits
<a href="#interfaces_class_traits" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-Convert.html"><abbr title="\footnotes\includes\Convert">Convert</abbr></a></dt>
<dd>Class providing variable type and value conversion functions.</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 -function -">
<a href="namespaces/footnotes.html#function_activate_footnotes">activate_footnotes()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Handles the activation of the plugin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a href="namespaces/footnotes.html#function_deactivate_footnotes">deactivate_footnotes()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Handles the deactivation of the plugin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a href="namespaces/footnotes.html#function_run_footnotes">run_footnotes()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Begins execution of the plugin.</dd>
</dl>
<section class="phpdocumentor-functions">
<h3 class="phpdocumentor-elements__header" id="functions">
Functions
<a href="packages/Default.html#functions" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_activate_footnotes">
activate_footnotes()
<a href="namespaces/footnotes.html#function_activate_footnotes" 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/footnotes.php"><a href="files/src-footnotes.html"><abbr title="src/footnotes.php">footnotes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">69</span>
</aside>
<p class="phpdocumentor-summary">Handles the activation of the plugin.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">activate_footnotes</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</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">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/footnotes-includes-Activator.html#method_activate"><abbr title="\footnotes\includes\Activator::activate()">Activator::activate()</abbr></a></span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_deactivate_footnotes">
deactivate_footnotes()
<a href="namespaces/footnotes.html#function_deactivate_footnotes" 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/footnotes.php"><a href="files/src-footnotes.html"><abbr title="src/footnotes.php">footnotes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">84</span>
</aside>
<p class="phpdocumentor-summary">Handles the deactivation of the plugin.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">deactivate_footnotes</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</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">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/footnotes-includes-Deactivator.html#method_deactivate"><abbr title="\footnotes\includes\Deactivator::deactivate()">Deactivator::deactivate()</abbr></a></span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_run_footnotes">
run_footnotes()
<a href="namespaces/footnotes.html#function_run_footnotes" 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/footnotes.php"><a href="files/src-footnotes.html"><abbr title="src/footnotes.php">footnotes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">117</span>
</aside>
<p class="phpdocumentor-summary">Begins execution of the plugin.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">run_footnotes</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>Since everything within the plugin is registered via hooks, then kicking off
the plugin from this point in the file does not affect the page life cycle.</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>
</article>
</section>
</article>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">

9
docs/packages/default.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
@ -86,6 +94,7 @@
</h3>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></dt>
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></dt>
</dl>

8
docs/packages/footnotes-includes.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

184
docs/packages/footnotes.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
@ -86,7 +94,6 @@
</h3>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/footnotes-admin.html"><abbr title="\footnotes\admin">admin</abbr></a></dt>
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></dt>
</dl>
@ -112,8 +119,6 @@
<dd>Class providing action(s) on plugin activation.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-Config.html"><abbr title="\footnotes\includes\Config">Config</abbr></a></dt>
<dd>Class defining plugin constants.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-Convert.html"><abbr title="\footnotes\includes\Convert">Convert</abbr></a></dt>
<dd>Class providing variable type and value conversion functions.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-Core.html"><abbr title="\footnotes\includes\Core">Core</abbr></a></dt>
<dd>Class providing core plugin functionality.</dd>
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/footnotes-includes-Deactivator.html"><abbr title="\footnotes\includes\Deactivator">Deactivator</abbr></a></dt>
@ -136,181 +141,10 @@
</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 -function -">
<a href="namespaces/footnotes.html#function_activate_footnotes">activate_footnotes()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Handles the activation of the plugin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a href="namespaces/footnotes.html#function_deactivate_footnotes">deactivate_footnotes()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Handles the deactivation of the plugin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -function -">
<a href="namespaces/footnotes.html#function_run_footnotes">run_footnotes()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Begins execution of the plugin.</dd>
</dl>
<section class="phpdocumentor-functions">
<h3 class="phpdocumentor-elements__header" id="functions">
Functions
<a href="packages/footnotes.html#functions" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_activate_footnotes">
activate_footnotes()
<a href="namespaces/footnotes.html#function_activate_footnotes" 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/footnotes.php"><a href="files/src-footnotes.html"><abbr title="src/footnotes.php">footnotes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">69</span>
</aside>
<p class="phpdocumentor-summary">Handles the activation of the plugin.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">activate_footnotes</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</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">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/footnotes-includes-Activator.html#method_activate"><abbr title="\footnotes\includes\Activator::activate()">Activator::activate()</abbr></a></span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_deactivate_footnotes">
deactivate_footnotes()
<a href="namespaces/footnotes.html#function_deactivate_footnotes" 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/footnotes.php"><a href="files/src-footnotes.html"><abbr title="src/footnotes.php">footnotes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">86</span>
</aside>
<p class="phpdocumentor-summary">Handles the deactivation of the plugin.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">deactivate_footnotes</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</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">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/footnotes-includes-Deactivator.html#method_deactivate"><abbr title="\footnotes\includes\Deactivator::deactivate()">Deactivator::deactivate()</abbr></a></span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -function - ">
<h4 class="phpdocumentor-element__name" id="function_run_footnotes">
run_footnotes()
<a href="namespaces/footnotes.html#function_run_footnotes" 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/footnotes.php"><a href="files/src-footnotes.html"><abbr title="src/footnotes.php">footnotes.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">114</span>
</aside>
<p class="phpdocumentor-summary">Begins execution of the plugin.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility"></span>
<span class="phpdocumentor-signature__name">run_footnotes</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>Since everything within the plugin is registered via hooks, then kicking off
the plugin from this point in the file does not affect the page life cycle.</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>
</article>
</section>
</article>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">

36
docs/reports/deprecated.html
View file

@ -60,6 +60,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
@ -104,7 +112,7 @@
<th class="phpdocumentor-heading">Reason</th>
</tr>
<tr>
<td class="phpdocumentor-cell">1108</td>
<td class="phpdocumentor-cell">1016</td>
<td class="phpdocumentor-cell"><a href="classes/footnotes-admin-layout-Settings.html#method_custom_css_migration"><abbr title="\footnotes\admin\layout\Settings::custom_css_migration()">Settings::custom_css_migration()</abbr></a></td>
<td class="phpdocumentor-cell"></td>
</tr>
@ -118,33 +126,33 @@
<th class="phpdocumentor-heading">Reason</th>
</tr>
<tr>
<td class="phpdocumentor-cell">46</td>
<td class="phpdocumentor-cell">48</td>
<td class="phpdocumentor-cell"><a href="classes/footnotes-includes-Config.html"><abbr title="\footnotes\includes\Config">Config</abbr></a></td>
<td class="phpdocumentor-cell"></td>
</tr>
<tr>
<td class="phpdocumentor-cell">56</td>
<td class="phpdocumentor-cell"><a href="classes/footnotes-includes-Config.html#constant_C_STR_PLUGIN_PUBLIC_NAME"><abbr title="\footnotes\includes\Config::C_STR_PLUGIN_PUBLIC_NAME">Config::C_STR_PLUGIN_PUBLIC_NAME</abbr></a></td>
<td class="phpdocumentor-cell">58</td>
<td class="phpdocumentor-cell"><a href="classes/footnotes-includes-Config.html#constant_PLUGIN_PUBLIC_NAME"><abbr title="\footnotes\includes\Config::PLUGIN_PUBLIC_NAME">Config::PLUGIN_PUBLIC_NAME</abbr></a></td>
<td class="phpdocumentor-cell"></td>
</tr>
<tr>
<td class="phpdocumentor-cell">73</td>
<td class="phpdocumentor-cell"><a href="classes/footnotes-includes-Config.html#constant_C_STR_PLUGIN_HEADING_NAME"><abbr title="\footnotes\includes\Config::C_STR_PLUGIN_HEADING_NAME">Config::C_STR_PLUGIN_HEADING_NAME</abbr></a></td>
<td class="phpdocumentor-cell">75</td>
<td class="phpdocumentor-cell"><a href="classes/footnotes-includes-Config.html#constant_PLUGIN_HEADING_NAME"><abbr title="\footnotes\includes\Config::PLUGIN_HEADING_NAME">Config::PLUGIN_HEADING_NAME</abbr></a></td>
<td class="phpdocumentor-cell"></td>
</tr>
<tr>
<td class="phpdocumentor-cell">84</td>
<td class="phpdocumentor-cell"><a href="classes/footnotes-includes-Config.html#constant_C_STR_LOVE_SYMBOL"><abbr title="\footnotes\includes\Config::C_STR_LOVE_SYMBOL">Config::C_STR_LOVE_SYMBOL</abbr></a></td>
<td class="phpdocumentor-cell">86</td>
<td class="phpdocumentor-cell"><a href="classes/footnotes-includes-Config.html#constant_LOVE_SYMBOL"><abbr title="\footnotes\includes\Config::LOVE_SYMBOL">Config::LOVE_SYMBOL</abbr></a></td>
<td class="phpdocumentor-cell"></td>
</tr>
<tr>
<td class="phpdocumentor-cell">95</td>
<td class="phpdocumentor-cell"><a href="classes/footnotes-includes-Config.html#constant_C_STR_LOVE_SYMBOL_HEADING"><abbr title="\footnotes\includes\Config::C_STR_LOVE_SYMBOL_HEADING">Config::C_STR_LOVE_SYMBOL_HEADING</abbr></a></td>
<td class="phpdocumentor-cell">97</td>
<td class="phpdocumentor-cell"><a href="classes/footnotes-includes-Config.html#constant_LOVE_SYMBOL_HEADING"><abbr title="\footnotes\includes\Config::LOVE_SYMBOL_HEADING">Config::LOVE_SYMBOL_HEADING</abbr></a></td>
<td class="phpdocumentor-cell"></td>
</tr>
<tr>
<td class="phpdocumentor-cell">106</td>
<td class="phpdocumentor-cell"><a href="classes/footnotes-includes-Config.html#constant_C_STR_NO_LOVE_SLUG"><abbr title="\footnotes\includes\Config::C_STR_NO_LOVE_SLUG">Config::C_STR_NO_LOVE_SLUG</abbr></a></td>
<td class="phpdocumentor-cell">108</td>
<td class="phpdocumentor-cell"><a href="classes/footnotes-includes-Config.html#constant_NO_LOVE_SLUG"><abbr title="\footnotes\includes\Config::NO_LOVE_SLUG">Config::NO_LOVE_SLUG</abbr></a></td>
<td class="phpdocumentor-cell"></td>
</tr>
</table>
@ -157,8 +165,8 @@
<th class="phpdocumentor-heading">Reason</th>
</tr>
<tr>
<td class="phpdocumentor-cell">293</td>
<td class="phpdocumentor-cell"><a href="classes/footnotes-includes-Settings.html#constant_C_STR_FOOTNOTES_EXPERT_MODE"><abbr title="\footnotes\includes\Settings::C_STR_FOOTNOTES_EXPERT_MODE">Settings::C_STR_FOOTNOTES_EXPERT_MODE</abbr></a></td>
<td class="phpdocumentor-cell">295</td>
<td class="phpdocumentor-cell"><a href="classes/footnotes-includes-Settings.html#constant_FOOTNOTES_EXPERT_MODE"><abbr title="\footnotes\includes\Settings::FOOTNOTES_EXPERT_MODE">Settings::FOOTNOTES_EXPERT_MODE</abbr></a></td>
<td class="phpdocumentor-cell"></td>
</tr>
</table>

8
docs/reports/errors.html
View file

@ -60,6 +60,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>

243
docs/reports/markers.html
View file

@ -60,6 +60,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
@ -91,6 +99,10 @@
<tr>
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/admin/layout/class-engine.php">src/admin/layout/class-engine.php</a></td>
<td class="phpdocumentor-cell">16</td>
</tr>
<tr>
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/admin/layout/class-settings.php">src/admin/layout/class-settings.php</a></td>
<td class="phpdocumentor-cell">1</td>
</tr>
<tr>
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/includes/class-config.php">src/includes/class-config.php</a></td>
@ -98,19 +110,23 @@
</tr>
<tr>
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/includes/class-convert.php">src/includes/class-convert.php</a></td>
<td class="phpdocumentor-cell">5</td>
<td class="phpdocumentor-cell">6</td>
</tr>
<tr>
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/includes/class-settings.php">src/includes/class-settings.php</a></td>
<td class="phpdocumentor-cell">7</td>
<td class="phpdocumentor-cell">9</td>
</tr>
<tr>
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/includes/class-template.php">src/includes/class-template.php</a></td>
<td class="phpdocumentor-cell">7</td>
<td class="phpdocumentor-cell">8</td>
</tr>
<tr>
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/public/class-general.php">src/public/class-general.php</a></td>
<td class="phpdocumentor-cell">1</td>
</tr>
<tr>
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/public/class-parser.php">src/public/class-parser.php</a></td>
<td class="phpdocumentor-cell">8</td>
<td class="phpdocumentor-cell">9</td>
</tr>
<tr>
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/public/widget/class-base.php">src/public/widget/class-base.php</a></td>
@ -135,12 +151,12 @@
<tbody>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">60</td>
<td class="phpdocumentor-cell">39</td>
<td class="phpdocumentor-cell">Should this be `static`?</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">86</td>
<td class="phpdocumentor-cell">65</td>
<td class="phpdocumentor-cell">Should this be `static`?</td>
</tr>
</tbody>
@ -158,83 +174,101 @@
<tbody>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">137</td>
<td class="phpdocumentor-cell">Refactor sections into their own class?</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">167</td>
<td class="phpdocumentor-cell">Refactor meta boxes into their own class?</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">167</td>
<td class="phpdocumentor-cell">Pass actual functions rather than strings?</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">253</td>
<td class="phpdocumentor-cell">Move to {@see}.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">266</td>
<td class="phpdocumentor-cell">122</td>
<td class="phpdocumentor-cell">Review nonce verification.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">339</td>
<td class="phpdocumentor-cell">Review nonce verification.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">368</td>
<td class="phpdocumentor-cell">184</td>
<td class="phpdocumentor-cell">Required? Should be `abstract`?</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">409</td>
<td class="phpdocumentor-cell">249</td>
<td class="phpdocumentor-cell">Refactor sections into their own class?</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">279</td>
<td class="phpdocumentor-cell">Refactor meta boxes into their own class?</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">279</td>
<td class="phpdocumentor-cell">Pass actual functions rather than strings?</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">324</td>
<td class="phpdocumentor-cell">Refactor HTML generation.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">424</td>
<td class="phpdocumentor-cell">338</td>
<td class="phpdocumentor-cell">Refactor HTML generation.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">456</td>
<td class="phpdocumentor-cell">369</td>
<td class="phpdocumentor-cell">Refactor HTML generation.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">484</td>
<td class="phpdocumentor-cell">396</td>
<td class="phpdocumentor-cell">Refactor HTML generation.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">506</td>
<td class="phpdocumentor-cell">417</td>
<td class="phpdocumentor-cell">Refactor HTML generation.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">541</td>
<td class="phpdocumentor-cell">451</td>
<td class="phpdocumentor-cell">Refactor HTML generation.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">564</td>
<td class="phpdocumentor-cell">473</td>
<td class="phpdocumentor-cell">Refactor HTML generation.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">564</td>
<td class="phpdocumentor-cell">473</td>
<td class="phpdocumentor-cell">Use proper colorpicker element.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">588</td>
<td class="phpdocumentor-cell">496</td>
<td class="phpdocumentor-cell">Refactor HTML generation.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">551</td>
<td class="phpdocumentor-cell">Move to {@see}.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">567</td>
<td class="phpdocumentor-cell">Review nonce verification.</td>
</tr>
</tbody>
</table>
<a id="src/admin/layout/class-settings.php"></a>
<h3><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></h3>
<table>
<thead>
<tr>
<th class="phpdocumentor-heading">Type</th>
<th class="phpdocumentor-heading">Line</th>
<th class="phpdocumentor-heading">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">1139</td>
<td class="phpdocumentor-cell">Review in light of admin/public split.</td>
</tr>
</tbody>
</table>
@ -251,32 +285,32 @@
<tbody>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">46</td>
<td class="phpdocumentor-cell">48</td>
<td class="phpdocumentor-cell">Remove.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">56</td>
<td class="phpdocumentor-cell">58</td>
<td class="phpdocumentor-cell">Remove.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">73</td>
<td class="phpdocumentor-cell">75</td>
<td class="phpdocumentor-cell">Remove.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">84</td>
<td class="phpdocumentor-cell">86</td>
<td class="phpdocumentor-cell">Remove.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">95</td>
<td class="phpdocumentor-cell">97</td>
<td class="phpdocumentor-cell">Remove.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">106</td>
<td class="phpdocumentor-cell">108</td>
<td class="phpdocumentor-cell">Remove.</td>
</tr>
</tbody>
@ -294,28 +328,33 @@
<tbody>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">60</td>
<td class="phpdocumentor-cell">Replace with built-in char casting.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">92</td>
<td class="phpdocumentor-cell">Replace with built-in string formatting.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">154</td>
<td class="phpdocumentor-cell">58</td>
<td class="phpdocumentor-cell">Replace with built-in type casting.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">179</td>
<td class="phpdocumentor-cell">84</td>
<td class="phpdocumentor-cell">Review.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">203</td>
<td class="phpdocumentor-cell">84</td>
<td class="phpdocumentor-cell">Single return type.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">112</td>
<td class="phpdocumentor-cell">Replace with proper logging/debug functions.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">149</td>
<td class="phpdocumentor-cell">Replace with built-in char casting.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">180</td>
<td class="phpdocumentor-cell">Replace with built-in string formatting.</td>
</tr>
</tbody>
</table>
@ -332,43 +371,53 @@
<tbody>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">1350</td>
<td class="phpdocumentor-cell">Remove?</td>
<td class="phpdocumentor-cell">1391</td>
<td class="phpdocumentor-cell">Add return type.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">48</td>
<td class="phpdocumentor-cell">50</td>
<td class="phpdocumentor-cell">Refactor to use sane typing.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">202</td>
<td class="phpdocumentor-cell">204</td>
<td class="phpdocumentor-cell">The mouse-over content truncation should be enabled by default to raise
awareness of the functionality, prevent the screen from being filled on
mouse-over, and allow the use of ‘Continue Reading’ functionality.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">234</td>
<td class="phpdocumentor-cell">236</td>
<td class="phpdocumentor-cell">In titles, footnotes are still buggy, because WordPress uses the
title string in menus and in the title element, but Footnotes doesn&#039;t
delete footnotes in them.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">293</td>
<td class="phpdocumentor-cell">295</td>
<td class="phpdocumentor-cell">Un-deprecate.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">1082</td>
<td class="phpdocumentor-cell">1084</td>
<td class="phpdocumentor-cell">Review, remove?</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">1142</td>
<td class="phpdocumentor-cell">1132</td>
<td class="phpdocumentor-cell">Review. Why are the constants just initialised with these values?
At the very least, we should stop using ‘yes’ to mean `true` etc.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">1132</td>
<td class="phpdocumentor-cell">Create `PreferencesSet` class.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">1322</td>
<td class="phpdocumentor-cell">Create `PreferencesSet` class.</td>
</tr>
</tbody>
</table>
@ -385,17 +434,17 @@ At the very least, we should stop using ‘yes’ to mean `true` etc.</td>
<tbody>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">28</td>
<td class="phpdocumentor-cell">30</td>
<td class="phpdocumentor-cell">Refactor templating.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">85</td>
<td class="phpdocumentor-cell">81</td>
<td class="phpdocumentor-cell">Refactor templating.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">111</td>
<td class="phpdocumentor-cell">109</td>
<td class="phpdocumentor-cell">Refactor templating.</td>
</tr>
<tr>
@ -415,8 +464,31 @@ At the very least, we should stop using ‘yes’ to mean `true` etc.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">183</td>
<td class="phpdocumentor-cell">184</td>
<td class="phpdocumentor-cell">Refactor templating.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">184</td>
<td class="phpdocumentor-cell">Single return type.</td>
</tr>
</tbody>
</table>
<a id="src/public/class-general.php"></a>
<h3><abbr title="src/public/class-general.php">class-general.php</abbr></h3>
<table>
<thead>
<tr>
<th class="phpdocumentor-heading">Type</th>
<th class="phpdocumentor-heading">Line</th>
<th class="phpdocumentor-heading">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">64</td>
<td class="phpdocumentor-cell">Review null init.</td>
</tr>
</tbody>
</table>
@ -433,42 +505,47 @@ At the very least, we should stop using ‘yes’ to mean `true` etc.</td>
<tbody>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">267</td>
<td class="phpdocumentor-cell">253</td>
<td class="phpdocumentor-cell">Reorganise dependencies.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">267</td>
<td class="phpdocumentor-cell">253</td>
<td class="phpdocumentor-cell">Move call to `register_hooks()` to {@see}.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">287</td>
<td class="phpdocumentor-cell">273</td>
<td class="phpdocumentor-cell">Move to {@see}.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">380</td>
<td class="phpdocumentor-cell">402</td>
<td class="phpdocumentor-cell">Refactor to enqueue stylesheets properly in {@see}.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">1144</td>
<td class="phpdocumentor-cell">1159</td>
<td class="phpdocumentor-cell">Refactor to parse DOM rather than using RegEx.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">155</td>
<td class="phpdocumentor-cell">1159</td>
<td class="phpdocumentor-cell">Decompose.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">150</td>
<td class="phpdocumentor-cell">Remove.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">164</td>
<td class="phpdocumentor-cell">158</td>
<td class="phpdocumentor-cell">Remove.</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">173</td>
<td class="phpdocumentor-cell">166</td>
<td class="phpdocumentor-cell">Remove.</td>
</tr>
</tbody>
@ -486,7 +563,7 @@ At the very least, we should stop using ‘yes’ to mean `true` etc.</td>
<tbody>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">29</td>
<td class="phpdocumentor-cell">31</td>
<td class="phpdocumentor-cell">Review implemenation of Widgets API.</td>
</tr>
</tbody>
@ -504,7 +581,7 @@ At the very least, we should stop using ‘yes’ to mean `true` etc.</td>
<tbody>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">27</td>
<td class="phpdocumentor-cell">30</td>
<td class="phpdocumentor-cell">Review implemenation of Widgets API.</td>
</tr>
</tbody>