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-08-09 11:27:33 +01:00
parent fbb00fab2f
commit 8b2f98184d
118 changed files with 59971 additions and 8570 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -8,12 +8,16 @@
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/js/all.min.js" integrity="sha256-0vuk8LXoyrmCjp1f0O300qo1M75ZQyhH9X3J6d+scmk=" crossorigin="anonymous"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
@ -48,10 +52,11 @@
Menu
</label>
<aside class="phpdocumentor-column -four phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h4>
<h3 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/default.html"><abbr title="\">Global</abbr></a></h3>
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h4>
<ul class="phpdocumentor-list">
<li><a href="namespaces/footnotes-admin.html"><abbr title="\footnotes\admin">admin</abbr></a></li>
<li><a href="namespaces/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
@ -61,8 +66,7 @@
<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>
<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>
@ -106,7 +110,8 @@
<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">48</span>
</aside>
</aside>
<p class="phpdocumentor-summary">Class providing core plugin functionality.</p>
@ -126,8 +131,7 @@ public-facing site hooks.</p>
<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>
@ -153,7 +157,14 @@ Moved under <code class="prettyprint">footnotes\includes</code> namespace.</p>
</h3>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a href="classes/footnotes-includes-Core.html#property_settings">$settings</a>
<span>
&nbsp;: <a href="classes/footnotes-includes-Settings.html"><abbr title="\footnotes\includes\Settings">Settings</abbr></a> </span>
</dt>
<dd>The plugin settings object.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/footnotes-includes-Core.html#property_loader">$loader</a>
<span>
&nbsp;: <a href="classes/footnotes-includes-Loader.html"><abbr title="\footnotes\includes\Loader">Loader</abbr></a> </span>
@ -254,6 +265,63 @@ the plugin.</dd>
<a href="classes/footnotes-includes-Core.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_settings">
$settings
<a href="classes/footnotes-includes-Core.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/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">84</span>
</aside>
<p class="phpdocumentor-summary">The plugin settings object.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type"><a href="classes/footnotes-includes-Settings.html"><abbr title="\footnotes\includes\Settings">Settings</abbr></a></span>
<span class="phpdocumentor-signature__name">$settings</span>
</code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>private</p>
</section>
</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>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
@ -270,7 +338,8 @@ the plugin.</dd>
<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">57</span>
</aside>
</aside>
<p class="phpdocumentor-summary">The loader that&#039;s responsible for maintaining and registering all hooks
that power the plugin.</p>
@ -281,7 +350,9 @@ that power the plugin.</p>
<span class="phpdocumentor-signature__name">$loader</span>
</code>
<section class="phpdocumentor-description"></section>
<section class="phpdocumentor-description"><p>Maintains and registers all hooks for the plugin.</p>
</section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
@ -295,8 +366,7 @@ that power the plugin.</p>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
@ -318,7 +388,8 @@ that power the plugin.</p>
<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">66</span>
</aside>
</aside>
<p class="phpdocumentor-summary">The unique identifier of this plugin</p>
@ -328,7 +399,9 @@ that power the plugin.</p>
<span class="phpdocumentor-signature__name">$plugin_name</span>
</code>
<section class="phpdocumentor-description"></section>
<section class="phpdocumentor-description"><p>The string used to uniquely identify this plugin.</p>
</section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
@ -342,8 +415,7 @@ that power the plugin.</p>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
@ -365,7 +437,8 @@ that power the plugin.</p>
<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">76</span>
</aside>
</aside>
<p class="phpdocumentor-summary">The current version of the plugin.</p>
@ -375,7 +448,9 @@ that power the plugin.</p>
<span class="phpdocumentor-signature__name">$version</span>
</code>
<section class="phpdocumentor-description"></section>
<section class="phpdocumentor-description"><p>The current version of the plugin.</p>
</section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
@ -389,8 +464,7 @@ that power the plugin.</p>
<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>
@ -398,8 +472,7 @@ that power the plugin.</p>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\footnotes\includes\PLUGIN_VERSION">PLUGIN_VERSION</abbr></span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
@ -424,8 +497,9 @@ 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">90</span>
</aside>
<span class="phpdocumentor-element-found-in__line">98</span>
</aside>
<p class="phpdocumentor-summary">Builds the core of the plugin.</p>
@ -451,8 +525,7 @@ the admin area and the public-facing side of the site.</p>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.0.0</span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">global</span>
@ -468,8 +541,7 @@ the admin area and the public-facing side of the site.</p>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
@ -485,8 +557,9 @@ 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">126</span>
</aside>
<span class="phpdocumentor-element-found-in__line">136</span>
</aside>
<p class="phpdocumentor-summary">Returns a reference to the class that orchestrates the hooks with the plugin.</p>
@ -494,8 +567,7 @@ the admin area and the public-facing side of the site.</p>
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">get_loader</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/footnotes-includes-Loader.html"><abbr title="\footnotes\includes\Loader">Loader</abbr></a></span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
@ -509,16 +581,14 @@ the admin area and the public-facing side of the site.</p>
<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"><a href="classes/footnotes-includes-Loader.html"><abbr title="\footnotes\includes\Loader">Loader</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
@ -534,19 +604,30 @@ 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">117</span>
</aside>
<span class="phpdocumentor-element-found-in__line">126</span>
</aside>
<p class="phpdocumentor-summary">Gets the name of the plugin used to uniquely identify it within the
context of WordPress and to define internationalization functionality.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">get_plugin_name</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section>
<span class="phpdocumentor-signature__name">get_plugin_name</span><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">$html</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<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">$html</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">false</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
@ -559,16 +640,14 @@ context of WordPress and to define internationalization functionality.</p>
<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">string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
@ -584,8 +663,9 @@ 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">135</span>
</aside>
<span class="phpdocumentor-element-found-in__line">145</span>
</aside>
<p class="phpdocumentor-summary">Gets the version number of the plugin.</p>
@ -593,8 +673,7 @@ context of WordPress and to define internationalization functionality.</p>
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">get_version</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
@ -608,16 +687,14 @@ context of WordPress and to define internationalization functionality.</p>
<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">string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
@ -633,8 +710,9 @@ 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">107</span>
</aside>
<span class="phpdocumentor-element-found-in__line">116</span>
</aside>
<p class="phpdocumentor-summary">Runs the loader to execute all of the hooks with WordPress.</p>
@ -642,8 +720,7 @@ context of WordPress and to define internationalization functionality.</p>
<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">void</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
@ -657,16 +734,14 @@ context of WordPress and to define internationalization functionality.</p>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
@ -682,8 +757,9 @@ 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">223</span>
</aside>
<span class="phpdocumentor-element-found-in__line">233</span>
</aside>
<p class="phpdocumentor-summary">Register all of the hooks related to the admin area functionality of the
plugin.</p>
@ -692,8 +768,7 @@ plugin.</p>
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">define_admin_hooks</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">
@ -707,8 +782,7 @@ plugin.</p>
<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>
@ -716,7 +790,7 @@ plugin.</p>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
<section class="phpdocumentor-description"><p>Moved hook registrations from various classes into <code class="prettyprint">Admin\Admin</code>.</p>
<section class="phpdocumentor-description"><p>Moved hook registrations from various classes into <code class="prettyprint">Admin</code>.</p>
</section>
</dd>
@ -735,8 +809,7 @@ plugin.</p>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
@ -752,8 +825,9 @@ 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">253</span>
</aside>
<span class="phpdocumentor-element-found-in__line">263</span>
</aside>
<p class="phpdocumentor-summary">Register all of the hooks related to the public-facing functionality of
the plugin.</p>
@ -762,8 +836,7 @@ the plugin.</p>
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">define_public_hooks</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">
@ -777,8 +850,7 @@ the plugin.</p>
<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>
@ -795,8 +867,7 @@ the plugin.</p>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
@ -812,8 +883,9 @@ 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">159</span>
</aside>
<span class="phpdocumentor-element-found-in__line">170</span>
</aside>
<p class="phpdocumentor-summary">Load the required dependencies for this plugin.</p>
@ -838,7 +910,7 @@ the plugin.</p>
<li>
<a href="classes/footnotes-admin-Admin.html"><abbr title="\footnotes\admin\Admin">Admin</abbr></a>: defines all hooks for the admin area; and</li>
<li>
<abbr title="\footnotes\general\Public">Public</abbr>: defines all hooks for the public side of the site.</li>
<a href="classes/footnotes-general-General.html"><abbr title="\footnotes\general\General">General</abbr></a>: defines all hooks for the public side of the site.</li>
</ul>
<p>Creates an instance of the loader which will be used to register the hooks
with WordPress.</p>
@ -857,16 +929,14 @@ with WordPress.</p>
<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">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
@ -882,8 +952,9 @@ 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">206</span>
</aside>
<span class="phpdocumentor-element-found-in__line">216</span>
</aside>
<p class="phpdocumentor-summary">Define the locale for this plugin for internationalization.</p>
@ -908,8 +979,7 @@ register the hook with WordPress.</p>
<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">uses</span>
@ -926,12 +996,73 @@ register the hook with WordPress.</p>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
</section>
<script type="text/javascript">
function loadExternalCodeSnippets(line) {
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
var src = pre.getAttribute('data-src').replace( /\\/g, '/');
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
var language = 'php';
var code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
}
else if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
}
else {
code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
}
}
};
xhr.send(null);
});
}
var modals = document.querySelectorAll("[data-modal]");
modals.forEach(function (trigger) {
trigger.addEventListener("click", function (event) {
//event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippets(trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
</script>
</article>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
@ -953,5 +1084,9 @@ register the hook with WordPress.</p>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>