docs: update documentation
This commit is contained in:
parent
39072041c7
commit
94cfdf2969
107 changed files with 39813 additions and 6661 deletions
|
|
@ -51,18 +51,13 @@
|
|||
|
||||
<section class="phpdocumentor-sidebar__category">
|
||||
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
|
||||
</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>
|
||||
<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-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>
|
||||
|
|
@ -79,7 +74,6 @@
|
|||
|
||||
<div class="phpdocumentor-column -eight phpdocumentor-content">
|
||||
<ul class="phpdocumentor-breadcrumbs">
|
||||
<li class="phpdocumentor-breadcrumb"><a href="packages/footnotes.html">footnotes</a></li>
|
||||
</ul>
|
||||
|
||||
<article class="phpdocumentor-element -class">
|
||||
|
|
@ -87,12 +81,6 @@
|
|||
Footnotes_Template
|
||||
|
||||
|
||||
<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>
|
||||
|
|
@ -100,12 +88,13 @@
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes-template.php"><a href="files/src-includes-class-footnotes-template.html"><abbr title="src/includes/class-footnotes-template.php">class-footnotes-template.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">19</span>
|
||||
<span class="phpdocumentor-element-found-in__line">26</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).</p>
|
||||
<p class="phpdocumentor-summary">Class defining template rendering.</p>
|
||||
|
||||
<section class="phpdocumentor-description"><p>Loads a template file, replaces all Placeholders and returns the replaced file content.</p>
|
||||
<section class="phpdocumentor-description"><p>Loads a template file, replaces all Placeholders and returns the replaced
|
||||
file content.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -115,6 +104,15 @@
|
|||
</h5>
|
||||
<dl class="phpdocumentor-tag-list">
|
||||
<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>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">since</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
|
@ -122,6 +120,15 @@
|
|||
|
||||
<section class="phpdocumentor-description"></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>Refactor templating.</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
|
@ -232,7 +239,7 @@
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes-template.php"><a href="files/src-includes-class-footnotes-template.html"><abbr title="src/includes/class-footnotes-template.php">class-footnotes-template.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">27</span>
|
||||
<span class="phpdocumentor-element-found-in__line">35</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Directory name for dashboard partials.</p>
|
||||
|
|
@ -274,7 +281,7 @@
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes-template.php"><a href="files/src-includes-class-footnotes-template.html"><abbr title="src/includes/class-footnotes-template.php">class-footnotes-template.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">35</span>
|
||||
<span class="phpdocumentor-element-found-in__line">44</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Directory name for public partials.</p>
|
||||
|
|
@ -331,7 +338,7 @@
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes-template.php"><a href="files/src-includes-class-footnotes-template.html"><abbr title="src/includes/class-footnotes-template.php">class-footnotes-template.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">60</span>
|
||||
<span class="phpdocumentor-element-found-in__line">71</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Plugin Directory</p>
|
||||
|
|
@ -378,7 +385,7 @@
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes-template.php"><a href="files/src-includes-class-footnotes-template.html"><abbr title="src/includes/class-footnotes-template.php">class-footnotes-template.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">43</span>
|
||||
<span class="phpdocumentor-element-found-in__line">53</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Contains the content of the template after initialize.</p>
|
||||
|
|
@ -425,7 +432,7 @@
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes-template.php"><a href="files/src-includes-class-footnotes-template.html"><abbr title="src/includes/class-footnotes-template.php">class-footnotes-template.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">51</span>
|
||||
<span class="phpdocumentor-element-found-in__line">62</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Contains the content of the template after initialize with replaced place holders.</p>
|
||||
|
|
@ -476,7 +483,7 @@
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes-template.php"><a href="files/src-includes-class-footnotes-template.html"><abbr title="src/includes/class-footnotes-template.php">class-footnotes-template.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">77</span>
|
||||
<span class="phpdocumentor-element-found-in__line">83</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Class Constructor. Reads and loads the template file without replace any placeholder.</p>
|
||||
|
|
@ -494,7 +501,7 @@
|
|||
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-argument-list__definition">
|
||||
<section class="phpdocumentor-description"><p>Template file type (take a look on the Class constants).</p>
|
||||
<section class="phpdocumentor-description"><p>Template file type.</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
|
|
@ -503,7 +510,7 @@
|
|||
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-argument-list__definition">
|
||||
<section class="phpdocumentor-description"><p>Template file name inside the Template directory without the file extension.</p>
|
||||
<section class="phpdocumentor-description"><p>Template file name inside the <code class="prettyprint">partials/</code> directory, without the file extension.</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
|
|
@ -512,10 +519,7 @@
|
|||
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
||||
= <span class="phpdocumentor-signature__argument__default-value">'html'</span> </dt>
|
||||
<dd class="phpdocumentor-argument-list__definition">
|
||||
<section class="phpdocumentor-description"><p>Optional Template file extension (default: html).</p>
|
||||
<ul>
|
||||
<li>Adding: Templates: support for custom templates in sibling folder, thanks to @misfist issue report.</li>
|
||||
</ul>
|
||||
<section class="phpdocumentor-description"><p>(optional) Template file extension (default: 'html').</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
|
|
@ -535,31 +539,15 @@
|
|||
|
||||
<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.2.6</span>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">reporter</span>
|
||||
<span class="phpdocumentor-tag__name">todo</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>@misfist</p>
|
||||
<section class="phpdocumentor-description"><p>Refactor templating.</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">link</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
<a class="phpdocumentor-tag-link" href="https://wordpress.org/support/topic/template-override-filter/"> https://wordpress.org/support/topic/template-override-filter/ </a>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
|
@ -583,7 +571,7 @@
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes-template.php"><a href="files/src-includes-class-footnotes-template.html"><abbr title="src/includes/class-footnotes-template.php">class-footnotes-template.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">143</span>
|
||||
<span class="phpdocumentor-element-found-in__line">144</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Returns the content of the template file with replaced placeholders.</p>
|
||||
|
|
@ -609,6 +597,15 @@
|
|||
|
||||
<section class="phpdocumentor-description"></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>Refactor templating.</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
|
@ -633,7 +630,7 @@
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes-template.php"><a href="files/src-includes-class-footnotes-template.html"><abbr title="src/includes/class-footnotes-template.php">class-footnotes-template.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">190</span>
|
||||
<span class="phpdocumentor-element-found-in__line">181</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Get the template.</p>
|
||||
|
|
@ -642,10 +639,7 @@
|
|||
<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 </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 </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 </span><span class="phpdocumentor-signature__argument__name">$p_str_extension</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'html'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
||||
|
||||
<section class="phpdocumentor-description"><ul>
|
||||
<li>Adding: Templates: Enable template location stack, thanks to @misfist issue report and code contribution.</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
||||
<dl class="phpdocumentor-argument-list">
|
||||
|
|
@ -687,45 +681,27 @@
|
|||
<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.0d3</span>
|
||||
|
||||
<section class="phpdocumentor-description"><p>Contribution.</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">since</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
<span class="phpdocumentor-tag-link">2.5.0</span>
|
||||
|
||||
<section class="phpdocumentor-description"><p>Release.</p>
|
||||
</section>
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">contributor</span>
|
||||
<span class="phpdocumentor-tag__name">todo</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>@misfist</p>
|
||||
<section class="phpdocumentor-description"><p>Refactor templating.</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">link</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
<a class="phpdocumentor-tag-link" href="https://wordpress.org/support/topic/template-override-filter/#post-13864301"> https://wordpress.org/support/topic/template-override-filter/#post-13864301 </a>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
||||
<span class="phpdocumentor-signature__response_type">mixed</span>
|
||||
—
|
||||
<section class="phpdocumentor-description"><p>false | template path</p>
|
||||
<section class="phpdocumentor-description"><p><code class="prettyprint">false</code> or the template path</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -743,7 +719,7 @@
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes-template.php"><a href="files/src-includes-class-footnotes-template.html"><abbr title="src/includes/class-footnotes-template.php">class-footnotes-template.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">161</span>
|
||||
<span class="phpdocumentor-element-found-in__line">157</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Process template file.</p>
|
||||
|
|
@ -782,53 +758,12 @@
|
|||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">since</span>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">todo</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
<span class="phpdocumentor-tag-link">2.0.3</span>
|
||||
|
||||
<section class="phpdocumentor-description"><p>Replace tab with a space.</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.0.3</span>
|
||||
|
||||
<section class="phpdocumentor-description"><p>Replace 2 spaces with 1.</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.0.4</span>
|
||||
|
||||
<section class="phpdocumentor-description"><p>Collapse multiple spaces.</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.2.6</span>
|
||||
|
||||
<section class="phpdocumentor-description"><p>Delete a space before a closing pointy bracket.</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">since</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
<span class="phpdocumentor-tag-link">2.5.4</span>
|
||||
|
||||
<section class="phpdocumentor-description"><p>Collapse HTML comments and PHP/JS docblocks (only).</p>
|
||||
<section class="phpdocumentor-description"><p>Refactor templating.</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
|
|
@ -854,7 +789,7 @@
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes-template.php"><a href="files/src-includes-class-footnotes-template.html"><abbr title="src/includes/class-footnotes-template.php">class-footnotes-template.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">133</span>
|
||||
<span class="phpdocumentor-element-found-in__line">132</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Reloads the original content of the template file.</p>
|
||||
|
|
@ -880,6 +815,15 @@
|
|||
|
||||
<section class="phpdocumentor-description"></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>Refactor templating.</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
|
@ -903,7 +847,7 @@
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes-template.php"><a href="files/src-includes-class-footnotes-template.html"><abbr title="src/includes/class-footnotes-template.php">class-footnotes-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>
|
||||
|
|
@ -941,13 +885,22 @@
|
|||
|
||||
<section class="phpdocumentor-description"></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>Refactor templating.</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
||||
<span class="phpdocumentor-signature__response_type">bool</span>
|
||||
—
|
||||
<section class="phpdocumentor-description"><p>True on Success, False if Placeholders invalid.</p>
|
||||
<section class="phpdocumentor-description"><p><code class="prettyprint">true</code> on Success, <code class="prettyprint">false</code> if placeholders invalid.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
|
|||
Reference in a new issue