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:49:15 +01:00
parent 8c639a97b5
commit 9f3762d3f4
66 changed files with 6328 additions and 2385 deletions
Download patch file Download diff file Expand all files Collapse all files

64
docs/classes/footnotes-includes-settings-SettingsSection.html
View file

@ -108,7 +108,7 @@
</h2>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settings-section.php"><a href="files/src-includes-settings-class-settings-section.html"><abbr title="src/includes/settings/class-settings-section.php">class-settings-section.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingssection.php"><a href="files/src-includes-settings-class-settingssection.html"><abbr title="src/includes/settings/class-settingssection.php">class-settingssection.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">24</span>
@ -219,14 +219,14 @@
<span>
&nbsp;: <a href="classes/footnotes-includes-settings-Setting.html"><abbr title="\footnotes\includes\settings\Setting">Setting</abbr></a>|null </span>
</dt>
<dd></dd>
<dd>Retrieve a setting by its key.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-settings-SettingsSection.html#method_get_setting_value">get_setting_value()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd></dd>
<dd>Retrieve a setting&#039;s default value by its key.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-settings-SettingsSection.html#method_get_settings_group">get_settings_group()</a>
@ -254,7 +254,7 @@
<span>
&nbsp;: bool|null </span>
</dt>
<dd></dd>
<dd>Set a setting&#039;s value by its key.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-settings-SettingsSection.html#method_setting_section_callback">setting_section_callback()</a>
@ -303,7 +303,7 @@
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settings-section.php"><a href="files/src-includes-settings-class-settings-section.html"><abbr title="src/includes/settings/class-settings-section.php">class-settings-section.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingssection.php"><a href="files/src-includes-settings-class-settingssection.html"><abbr title="src/includes/settings/class-settingssection.php">class-settingssection.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">32</span>
@ -350,7 +350,7 @@
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settings-section.php"><a href="files/src-includes-settings-class-settings-section.html"><abbr title="src/includes/settings/class-settings-section.php">class-settings-section.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingssection.php"><a href="files/src-includes-settings-class-settingssection.html"><abbr title="src/includes/settings/class-settingssection.php">class-settingssection.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">41</span>
@ -397,7 +397,7 @@
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settings-section.php"><a href="files/src-includes-settings-class-settings-section.html"><abbr title="src/includes/settings/class-settings-section.php">class-settings-section.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingssection.php"><a href="files/src-includes-settings-class-settingssection.html"><abbr title="src/includes/settings/class-settingssection.php">class-settingssection.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">59</span>
@ -444,7 +444,7 @@
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settings-section.php"><a href="files/src-includes-settings-class-settings-section.html"><abbr title="src/includes/settings/class-settings-section.php">class-settings-section.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingssection.php"><a href="files/src-includes-settings-class-settingssection.html"><abbr title="src/includes/settings/class-settingssection.php">class-settingssection.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">50</span>
@ -495,7 +495,7 @@
<a href="classes/footnotes-includes-settings-SettingsSection.html#method_add_settings_fields" 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/settings/class-settings-section.php"><a href="files/src-includes-settings-class-settings-section.html"><abbr title="src/includes/settings/class-settings-section.php">class-settings-section.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingssection.php"><a href="files/src-includes-settings-class-settingssection.html"><abbr title="src/includes/settings/class-settingssection.php">class-settingssection.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">93</span>
@ -539,7 +539,7 @@
<a href="classes/footnotes-includes-settings-SettingsSection.html#method_add_settings_section" 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/settings/class-settings-section.php"><a href="files/src-includes-settings-class-settings-section.html"><abbr title="src/includes/settings/class-settings-section.php">class-settings-section.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingssection.php"><a href="files/src-includes-settings-class-settingssection.html"><abbr title="src/includes/settings/class-settingssection.php">class-settingssection.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">84</span>
@ -572,9 +572,9 @@
<a href="classes/footnotes-includes-settings-SettingsSection.html#method_get_options" 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/settings/class-settings-section.php"><a href="files/src-includes-settings-class-settings-section.html"><abbr title="src/includes/settings/class-settings-section.php">class-settings-section.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingssection.php"><a href="files/src-includes-settings-class-settingssection.html"><abbr title="src/includes/settings/class-settingssection.php">class-settingssection.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">171</span>
<span class="phpdocumentor-element-found-in__line">175</span>
</aside>
@ -621,7 +621,7 @@
<a href="classes/footnotes-includes-settings-SettingsSection.html#method_get_options_group_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/settings/class-settings-section.php"><a href="files/src-includes-settings-class-settings-section.html"><abbr title="src/includes/settings/class-settings-section.php">class-settings-section.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingssection.php"><a href="files/src-includes-settings-class-settingssection.html"><abbr title="src/includes/settings/class-settingssection.php">class-settingssection.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">113</span>
@ -654,7 +654,7 @@
<a href="classes/footnotes-includes-settings-SettingsSection.html#method_get_section_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/settings/class-settings-section.php"><a href="files/src-includes-settings-class-settings-section.html"><abbr title="src/includes/settings/class-settings-section.php">class-settings-section.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingssection.php"><a href="files/src-includes-settings-class-settingssection.html"><abbr title="src/includes/settings/class-settingssection.php">class-settingssection.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">124</span>
@ -703,13 +703,14 @@
<a href="classes/footnotes-includes-settings-SettingsSection.html#method_get_setting" 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/settings/class-settings-section.php"><a href="files/src-includes-settings-class-settings-section.html"><abbr title="src/includes/settings/class-settings-section.php">class-settings-section.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingssection.php"><a href="files/src-includes-settings-class-settingssection.html"><abbr title="src/includes/settings/class-settingssection.php">class-settingssection.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">154</span>
<span class="phpdocumentor-element-found-in__line">156</span>
</aside>
<p class="phpdocumentor-summary">Retrieve a setting by its key.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">get_setting</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$setting_key</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/footnotes-includes-settings-Setting.html"><abbr title="\footnotes\includes\settings\Setting">Setting</abbr></a>|null</span></code>
@ -760,13 +761,14 @@
<a href="classes/footnotes-includes-settings-SettingsSection.html#method_get_setting_value" 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/settings/class-settings-section.php"><a href="files/src-includes-settings-class-settings-section.html"><abbr title="src/includes/settings/class-settings-section.php">class-settings-section.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingssection.php"><a href="files/src-includes-settings-class-settingssection.html"><abbr title="src/includes/settings/class-settingssection.php">class-settingssection.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">184</span>
<span class="phpdocumentor-element-found-in__line">190</span>
</aside>
<p class="phpdocumentor-summary">Retrieve a setting&#039;s default value by its key.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">get_setting_value</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$setting_key</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
@ -817,7 +819,7 @@
<a href="classes/footnotes-includes-settings-SettingsSection.html#method_get_settings_group" 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/settings/class-settings-section.php"><a href="files/src-includes-settings-class-settings-section.html"><abbr title="src/includes/settings/class-settings-section.php">class-settings-section.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingssection.php"><a href="files/src-includes-settings-class-settingssection.html"><abbr title="src/includes/settings/class-settingssection.php">class-settingssection.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">147</span>
@ -837,7 +839,8 @@
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
<section class="phpdocumentor-description"><p>The ID of the settings group.</p>
</section>
</dd>
</dl>
@ -877,7 +880,7 @@
<a href="classes/footnotes-includes-settings-SettingsSection.html#method_get_title" 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/settings/class-settings-section.php"><a href="files/src-includes-settings-class-settings-section.html"><abbr title="src/includes/settings/class-settings-section.php">class-settings-section.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingssection.php"><a href="files/src-includes-settings-class-settingssection.html"><abbr title="src/includes/settings/class-settingssection.php">class-settingssection.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">135</span>
@ -926,7 +929,7 @@
<a href="classes/footnotes-includes-settings-SettingsSection.html#method_load_options_group" 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/settings/class-settings-section.php"><a href="files/src-includes-settings-class-settings-section.html"><abbr title="src/includes/settings/class-settings-section.php">class-settings-section.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingssection.php"><a href="files/src-includes-settings-class-settingssection.html"><abbr title="src/includes/settings/class-settingssection.php">class-settingssection.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">74</span>
@ -959,13 +962,14 @@
<a href="classes/footnotes-includes-settings-SettingsSection.html#method_set_setting_value" 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/settings/class-settings-section.php"><a href="files/src-includes-settings-class-settings-section.html"><abbr title="src/includes/settings/class-settings-section.php">class-settings-section.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingssection.php"><a href="files/src-includes-settings-class-settingssection.html"><abbr title="src/includes/settings/class-settingssection.php">class-settingssection.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">194</span>
<span class="phpdocumentor-element-found-in__line">205</span>
</aside>
<p class="phpdocumentor-summary">Set a setting&#039;s value by its key.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">set_setting_value</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$setting_key</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool|null</span></code>
@ -1024,7 +1028,7 @@
<a href="classes/footnotes-includes-settings-SettingsSection.html#method_setting_section_callback" 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/settings/class-settings-section.php"><a href="files/src-includes-settings-class-settings-section.html"><abbr title="src/includes/settings/class-settings-section.php">class-settings-section.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingssection.php"><a href="files/src-includes-settings-class-settingssection.html"><abbr title="src/includes/settings/class-settingssection.php">class-settingssection.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">99</span>
@ -1057,7 +1061,7 @@
<a href="classes/footnotes-includes-settings-SettingsSection.html#method_add_settings_groups" 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/settings/class-settings-section.php"><a href="files/src-includes-settings-class-settings-section.html"><abbr title="src/includes/settings/class-settings-section.php">class-settings-section.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingssection.php"><a href="files/src-includes-settings-class-settingssection.html"><abbr title="src/includes/settings/class-settingssection.php">class-settingssection.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">111</span>
@ -1111,7 +1115,7 @@
<a href="classes/footnotes-includes-settings-SettingsSection.html#method_load_dependencies" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settings-section.php"><a href="files/src-includes-settings-class-settings-section.html"><abbr title="src/includes/settings/class-settings-section.php">class-settings-section.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingssection.php"><a href="files/src-includes-settings-class-settingssection.html"><abbr title="src/includes/settings/class-settingssection.php">class-settingssection.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">70</span>