docs: update documentation
This commit is contained in:
parent
39072041c7
commit
94cfdf2969
107 changed files with 39813 additions and 6661 deletions
|
@ -51,18 +51,9 @@
|
|||
|
||||
<section class="phpdocumentor-sidebar__category">
|
||||
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
|
||||
</section>
|
||||
<h3 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/default.html"><abbr title="\">Global</abbr></a></h3>
|
||||
</section>
|
||||
|
||||
<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>
|
||||
<ul class="phpdocumentor-list">
|
||||
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
|
||||
<li><a href="packages/footnotes-admin.html"><abbr title="\footnotes\admin">admin</abbr></a></li>
|
||||
<li><a href="packages/footnotes-public.html"><abbr title="\footnotes\public">public</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">
|
||||
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
|
||||
|
@ -88,13 +79,6 @@
|
|||
Footnotes
|
||||
|
||||
|
||||
<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>
|
||||
|
@ -102,15 +86,13 @@
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes.php"><a href="files/src-includes-class-footnotes.html"><abbr title="src/includes/class-footnotes.php">class-footnotes.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">27</span>
|
||||
<span class="phpdocumentor-element-found-in__line">39</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">The core plugin class.</p>
|
||||
<p class="phpdocumentor-summary">Class providing core plugin functionality.</p>
|
||||
|
||||
<section class="phpdocumentor-description"><p>This is used to define internationalization, admin-specific hooks, and
|
||||
public-facing site hooks.</p>
|
||||
<p>Also maintains the unique identifier of this plugin as well as the current
|
||||
version of the plugin.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
@ -127,15 +109,6 @@ version of the plugin.</p>
|
|||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">subpackage</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>includes</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
@ -155,8 +128,8 @@ version of the plugin.</p>
|
|||
<span>
|
||||
: <a href="classes/Footnotes-Loader.html"><abbr title="\Footnotes_Loader">Footnotes_Loader</abbr></a> </span>
|
||||
</dt>
|
||||
<dd>The loader that's responsible for maintaining and registering all hooks that power
|
||||
the plugin.</dd>
|
||||
<dd>The loader that's responsible for maintaining and registering all hooks
|
||||
that power the plugin.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
||||
<a href="classes/Footnotes.html#property_plugin_name">$plugin_name</a>
|
||||
|
@ -175,66 +148,66 @@ the plugin.</dd>
|
|||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||||
<a href="classes/Footnotes.html#method___construct">__construct()</a>
|
||||
<span>
|
||||
: mixed </span>
|
||||
: void </span>
|
||||
</dt>
|
||||
<dd>Define the core functionality of the plugin.</dd>
|
||||
<dd>Builds the core of the plugin.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||||
<a href="classes/Footnotes.html#method_get_loader">get_loader()</a>
|
||||
<span>
|
||||
: <a href="classes/Footnotes-Loader.html"><abbr title="\Footnotes_Loader">Footnotes_Loader</abbr></a> </span>
|
||||
</dt>
|
||||
<dd>The reference to the class that orchestrates the hooks with the plugin.</dd>
|
||||
<dd>Returns a reference to the class that orchestrates the hooks with the plugin.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||||
<a href="classes/Footnotes.html#method_get_plugin_name">get_plugin_name()</a>
|
||||
<span>
|
||||
: string </span>
|
||||
</dt>
|
||||
<dd>The name of the plugin used to uniquely identify it within the context of
|
||||
WordPress and to define internationalization functionality.</dd>
|
||||
<dd>Gets the name of the plugin used to uniquely identify it within the
|
||||
context of WordPress and to define internationalization functionality.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||||
<a href="classes/Footnotes.html#method_get_version">get_version()</a>
|
||||
<span>
|
||||
: string </span>
|
||||
</dt>
|
||||
<dd>Retrieve the version number of the plugin.</dd>
|
||||
<dd>Gets the version number of the plugin.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||||
<a href="classes/Footnotes.html#method_run">run()</a>
|
||||
<span>
|
||||
: mixed </span>
|
||||
: void </span>
|
||||
</dt>
|
||||
<dd>Run the loader to execute all of the hooks with WordPress.</dd>
|
||||
<dd>Runs the loader to execute all of the hooks with WordPress.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
||||
<a href="classes/Footnotes.html#method_define_admin_hooks">define_admin_hooks()</a>
|
||||
<span>
|
||||
: mixed </span>
|
||||
: void </span>
|
||||
</dt>
|
||||
<dd>Register all of the hooks related to the admin area functionality
|
||||
of the plugin.</dd>
|
||||
<dd>Register all of the hooks related to the admin area functionality of the
|
||||
plugin.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
||||
<a href="classes/Footnotes.html#method_define_public_hooks">define_public_hooks()</a>
|
||||
<span>
|
||||
: mixed </span>
|
||||
: void </span>
|
||||
</dt>
|
||||
<dd>Register all of the hooks related to the public-facing functionality
|
||||
of the plugin.</dd>
|
||||
<dd>Register all of the hooks related to the public-facing functionality of
|
||||
the plugin.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
||||
<a href="classes/Footnotes.html#method_load_dependencies">load_dependencies()</a>
|
||||
<span>
|
||||
: mixed </span>
|
||||
: void </span>
|
||||
</dt>
|
||||
<dd>Load the required dependencies for this plugin.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
||||
<a href="classes/Footnotes.html#method_set_locale">set_locale()</a>
|
||||
<span>
|
||||
: mixed </span>
|
||||
: void </span>
|
||||
</dt>
|
||||
<dd>Define the locale for this plugin for internationalization.</dd>
|
||||
|
||||
|
@ -266,11 +239,11 @@ of the plugin.</dd>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes.php"><a href="files/src-includes-class-footnotes.html"><abbr title="src/includes/class-footnotes.php">class-footnotes.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">36</span>
|
||||
<span class="phpdocumentor-element-found-in__line">48</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">The loader that's responsible for maintaining and registering all hooks that power
|
||||
the plugin.</p>
|
||||
<p class="phpdocumentor-summary">The loader that's responsible for maintaining and registering all hooks
|
||||
that power the plugin.</p>
|
||||
|
||||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||||
<span class="phpdocumentor-signature__visibility">protected</span>
|
||||
|
@ -294,15 +267,6 @@ the plugin.</p>
|
|||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">access</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>protected</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
@ -323,7 +287,7 @@ the plugin.</p>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes.php"><a href="files/src-includes-class-footnotes.html"><abbr title="src/includes/class-footnotes.php">class-footnotes.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">45</span>
|
||||
<span class="phpdocumentor-element-found-in__line">57</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">The unique identifier of this plugin</p>
|
||||
|
@ -350,15 +314,6 @@ the plugin.</p>
|
|||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">access</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>protected</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
@ -379,7 +334,7 @@ the plugin.</p>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes.php"><a href="files/src-includes-class-footnotes.html"><abbr title="src/includes/class-footnotes.php">class-footnotes.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">54</span>
|
||||
<span class="phpdocumentor-element-found-in__line">67</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">The current version of the plugin.</p>
|
||||
|
@ -408,12 +363,12 @@ the plugin.</p>
|
|||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">access</span>
|
||||
<span class="phpdocumentor-tag__name">see</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>protected</p>
|
||||
</section>
|
||||
<span class="phpdocumentor-tag-link"><abbr title="\PLUGIN_VERSION">PLUGIN_VERSION</abbr></span>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
@ -439,18 +394,18 @@ the plugin.</p>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes.php"><a href="files/src-includes-class-footnotes.html"><abbr title="src/includes/class-footnotes.php">class-footnotes.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">65</span>
|
||||
<span class="phpdocumentor-element-found-in__line">81</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Define the core functionality of the plugin.</p>
|
||||
<p class="phpdocumentor-summary">Builds the core of the plugin.</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"><p>Set the plugin name and the plugin version that can be used throughout the plugin.
|
||||
Load the dependencies, define the locale, and set the hooks for the admin area and
|
||||
the public-facing side of the site.</p>
|
||||
<section class="phpdocumentor-description"><p>Set the plugin name and the plugin version that can be used throughout the
|
||||
plugin. Load the dependencies, define the locale, and set the hooks for
|
||||
the admin area and the public-facing side of the site.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
@ -468,11 +423,20 @@ the public-facing side of the site.</p>
|
|||
|
||||
<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="\PLUGIN_VERSION">PLUGIN_VERSION</abbr></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>
|
||||
<span class="phpdocumentor-signature__response_type">void</span>
|
||||
—
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
@ -491,10 +455,10 @@ 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-footnotes.php"><a href="files/src-includes-class-footnotes.html"><abbr title="src/includes/class-footnotes.php">class-footnotes.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">229</span>
|
||||
<span class="phpdocumentor-element-found-in__line">249</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">The reference to the class that orchestrates the hooks with the plugin.</p>
|
||||
<p class="phpdocumentor-summary">Returns a reference to the class that orchestrates the hooks with the plugin.</p>
|
||||
|
||||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||||
<span class="phpdocumentor-signature__visibility">public</span>
|
||||
|
@ -513,7 +477,7 @@ the public-facing side of the site.</p>
|
|||
<span class="phpdocumentor-tag__name">since</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
<span class="phpdocumentor-tag-link">1.0.0</span>
|
||||
<span class="phpdocumentor-tag-link">2.8.0</span>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
@ -523,8 +487,7 @@ the public-facing side of the site.</p>
|
|||
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
||||
<span class="phpdocumentor-signature__response_type"><a href="classes/Footnotes-Loader.html"><abbr title="\Footnotes_Loader">Footnotes_Loader</abbr></a></span>
|
||||
—
|
||||
<section class="phpdocumentor-description"><p>Orchestrates the hooks of the plugin.</p>
|
||||
</section>
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
||||
</article>
|
||||
|
@ -541,11 +504,11 @@ 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-footnotes.php"><a href="files/src-includes-class-footnotes.html"><abbr title="src/includes/class-footnotes.php">class-footnotes.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">219</span>
|
||||
<span class="phpdocumentor-element-found-in__line">240</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">The name of the plugin used to uniquely identify it within the context of
|
||||
WordPress and to define internationalization functionality.</p>
|
||||
<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>
|
||||
|
@ -564,7 +527,7 @@ WordPress and to define internationalization functionality.</p>
|
|||
<span class="phpdocumentor-tag__name">since</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
<span class="phpdocumentor-tag-link">1.0.0</span>
|
||||
<span class="phpdocumentor-tag-link">2.8.0</span>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
@ -574,8 +537,7 @@ WordPress and to define internationalization functionality.</p>
|
|||
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
||||
<span class="phpdocumentor-signature__response_type">string</span>
|
||||
—
|
||||
<section class="phpdocumentor-description"><p>The name of the plugin.</p>
|
||||
</section>
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
||||
</article>
|
||||
|
@ -592,10 +554,10 @@ WordPress and to define internationalization functionality.</p>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes.php"><a href="files/src-includes-class-footnotes.html"><abbr title="src/includes/class-footnotes.php">class-footnotes.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">239</span>
|
||||
<span class="phpdocumentor-element-found-in__line">258</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Retrieve the version number of the plugin.</p>
|
||||
<p class="phpdocumentor-summary">Gets the version number of the plugin.</p>
|
||||
|
||||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||||
<span class="phpdocumentor-signature__visibility">public</span>
|
||||
|
@ -614,7 +576,7 @@ WordPress and to define internationalization functionality.</p>
|
|||
<span class="phpdocumentor-tag__name">since</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
<span class="phpdocumentor-tag-link">1.0.0</span>
|
||||
<span class="phpdocumentor-tag-link">2.8.0</span>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
@ -624,8 +586,7 @@ WordPress and to define internationalization functionality.</p>
|
|||
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
||||
<span class="phpdocumentor-signature__response_type">string</span>
|
||||
—
|
||||
<section class="phpdocumentor-description"><p>The version number of the plugin.</p>
|
||||
</section>
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
||||
</article>
|
||||
|
@ -642,14 +603,14 @@ WordPress and to define internationalization functionality.</p>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes.php"><a href="files/src-includes-class-footnotes.html"><abbr title="src/includes/class-footnotes.php">class-footnotes.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">208</span>
|
||||
<span class="phpdocumentor-element-found-in__line">230</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Run the loader to execute all of the hooks with WordPress.</p>
|
||||
<p class="phpdocumentor-summary">Runs the loader to execute all of the hooks 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>
|
||||
|
||||
|
@ -668,20 +629,11 @@ WordPress and to define internationalization functionality.</p>
|
|||
|
||||
<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="\self::initialize_widgets()">self::initialize_widgets()</abbr></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>
|
||||
<span class="phpdocumentor-signature__response_type">void</span>
|
||||
—
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
@ -700,15 +652,15 @@ WordPress and to define internationalization functionality.</p>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes.php"><a href="files/src-includes-class-footnotes.html"><abbr title="src/includes/class-footnotes.php">class-footnotes.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">162</span>
|
||||
<span class="phpdocumentor-element-found-in__line">182</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Register all of the hooks related to the admin area functionality
|
||||
of the plugin.</p>
|
||||
<p class="phpdocumentor-summary">Register all of the hooks related to the admin area functionality of the
|
||||
plugin.</p>
|
||||
|
||||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||||
<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">mixed</span></code>
|
||||
<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>
|
||||
|
||||
|
@ -734,23 +686,24 @@ of the plugin.</p>
|
|||
<dd class="phpdocumentor-tag-list__definition">
|
||||
<span class="phpdocumentor-tag-link">2.8.0</span>
|
||||
|
||||
<section class="phpdocumentor-description"><p>Moved registrating from various classes into <code class="prettyprint">Footnotes_Admin</code>.</p>
|
||||
<section class="phpdocumentor-description"><p>Moved hook registrations from various classes into <code class="prettyprint">Footnotes_Admin</code>.</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">access</span>
|
||||
<span class="phpdocumentor-tag__name">uses</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>private</p>
|
||||
<span class="phpdocumentor-tag-link"><a href="classes/Footnotes-Admin.html"><abbr title="\Footnotes_Admin">Footnotes_Admin</abbr></a></span>
|
||||
|
||||
<section class="phpdocumentor-description"><p>Defines admin functionality.</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>
|
||||
—
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
@ -769,15 +722,15 @@ of the plugin.</p>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes.php"><a href="files/src-includes-class-footnotes.html"><abbr title="src/includes/class-footnotes.php">class-footnotes.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">191</span>
|
||||
<span class="phpdocumentor-element-found-in__line">213</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Register all of the hooks related to the public-facing functionality
|
||||
of the plugin.</p>
|
||||
<p class="phpdocumentor-summary">Register all of the hooks related to the public-facing functionality of
|
||||
the plugin.</p>
|
||||
|
||||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||||
<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">mixed</span></code>
|
||||
<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>
|
||||
|
||||
|
@ -798,18 +751,19 @@ of the plugin.</p>
|
|||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">access</span>
|
||||
<span class="phpdocumentor-tag__name">uses</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>private</p>
|
||||
<span class="phpdocumentor-tag-link"><a href="classes/Footnotes-Admin.html"><abbr title="\Footnotes_Admin">Footnotes_Admin</abbr></a></span>
|
||||
|
||||
<section class="phpdocumentor-description"><p>Defines public-facing functionality.</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>
|
||||
—
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
@ -828,35 +782,35 @@ of the plugin.</p>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes.php"><a href="files/src-includes-class-footnotes.html"><abbr title="src/includes/class-footnotes.php">class-footnotes.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">100</span>
|
||||
<span class="phpdocumentor-element-found-in__line">116</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Load the required dependencies for this plugin.</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>
|
||||
<section class="phpdocumentor-description"><p>Includes the following files that make up the plugin:</p>
|
||||
<ul>
|
||||
<li>
|
||||
<code class="prettyprint">Footnotes_Loader</code>. Orchestrates the hooks of the plugin.</li>
|
||||
<a href="classes/Footnotes-Loader.html"><abbr title="\Footnotes_Loader">Footnotes_Loader</abbr></a>: orchestrates the hooks of the plugin;</li>
|
||||
<li>
|
||||
<code class="prettyprint">Footnotes_i18n</code>. Defines internationalization functionality.</li>
|
||||
<a href="classes/Footnotes-i18n.html"><abbr title="\Footnotes_i18n">Footnotes_i18n</abbr></a>: defines internationalization functionality;</li>
|
||||
<li>
|
||||
<code class="prettyprint">Footnotes_Config</code>. Defines plugin details.</li>
|
||||
<a href="classes/Footnotes-Config.html"><abbr title="\Footnotes_Config">Footnotes_Config</abbr></a>: defines plugin details;</li>
|
||||
<li>
|
||||
<code class="prettyprint">Footnotes_Convert</code>. Provides conversion methods.</li>
|
||||
<a href="classes/Footnotes-Convert.html"><abbr title="\Footnotes_Convert">Footnotes_Convert</abbr></a>: provides conversion methods;</li>
|
||||
<li>
|
||||
<code class="prettyprint">Footnotes_Settings</code>. Defines customisable plugin settings.</li>
|
||||
<a href="classes/Footnotes-Settings.html"><abbr title="\Footnotes_Settings">Footnotes_Settings</abbr></a>: defines customisable plugin settings;</li>
|
||||
<li>
|
||||
<code class="prettyprint">Footnotes_Template</code>. Handles template rendering.</li>
|
||||
<a href="classes/Footnotes-Template.html"><abbr title="\Footnotes_Template">Footnotes_Template</abbr></a>: handles template rendering;</li>
|
||||
<li>
|
||||
<code class="prettyprint">Footnotes_Admin</code>. Defines all hooks for the admin area.</li>
|
||||
<a href="classes/Footnotes-Admin.html"><abbr title="\Footnotes_Admin">Footnotes_Admin</abbr></a>: defines all hooks for the admin area; and</li>
|
||||
<li>
|
||||
<code class="prettyprint">Footnotes_Public</code>. Defines all hooks for the public side of the site.</li>
|
||||
<a href="classes/Footnotes-Public.html"><abbr title="\Footnotes_Public">Footnotes_Public</abbr></a>: defines all hooks for the public side of the site.</li>
|
||||
</ul>
|
||||
<p>Create an instance of the loader which will be used to register the hooks
|
||||
<p>Creates an instance of the loader which will be used to register the hooks
|
||||
with WordPress.</p>
|
||||
</section>
|
||||
|
||||
|
@ -875,20 +829,11 @@ with WordPress.</p>
|
|||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">access</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>private</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<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>
|
||||
—
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
@ -907,17 +852,17 @@ with WordPress.</p>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes.php"><a href="files/src-includes-class-footnotes.html"><abbr title="src/includes/class-footnotes.php">class-footnotes.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">146</span>
|
||||
<span class="phpdocumentor-element-found-in__line">164</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Define the locale for this plugin for internationalization.</p>
|
||||
|
||||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||||
<span class="phpdocumentor-signature__visibility">private</span>
|
||||
<span class="phpdocumentor-signature__name">set_locale</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
||||
<span class="phpdocumentor-signature__name">set_locale</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
||||
|
||||
<section class="phpdocumentor-description"><p>Uses the <code class="prettyprint">Footnotes_i18n</code> class in order to set the domain and to register the hook
|
||||
with WordPress.</p>
|
||||
<section class="phpdocumentor-description"><p>Uses <a href="classes/Footnotes-i18n.html"><abbr title="\Footnotes_i18n">Footnotes_i18n</abbr></a> in order to set the domain and to
|
||||
register the hook with WordPress.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
@ -937,18 +882,19 @@ with WordPress.</p>
|
|||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">access</span>
|
||||
<span class="phpdocumentor-tag__name">uses</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>private</p>
|
||||
<span class="phpdocumentor-tag-link"><a href="classes/Footnotes-i18n.html"><abbr title="\Footnotes_i18n">Footnotes_i18n</abbr></a></span>
|
||||
|
||||
<section class="phpdocumentor-description"><p>Handles initialization functions.</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>
|
||||
—
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
|
Reference in a new issue