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

90
docs/classes/footnotes-includes-settings-referrersandtooltips-BacklinkSymbolSettingsGroup.html
View file

@ -112,7 +112,7 @@
</h2>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/referrers-and-tooltips/class-backlink-symbol-settings-group.php"><a href="files/src-includes-settings-referrers-and-tooltips-class-backlink-symbol-settings-group.html"><abbr title="src/includes/settings/referrers-and-tooltips/class-backlink-symbol-settings-group.php">class-backlink-symbol-settings-group.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/referrers-and-tooltips/class-backlinksymbolsettingsgroup.php"><a href="files/src-includes-settings-referrers-and-tooltips-class-backlinksymbolsettingsgroup.html"><abbr title="src/includes/settings/referrers-and-tooltips/class-backlinksymbolsettingsgroup.php">class-backlinksymbolsettingsgroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">23</span>
@ -230,28 +230,28 @@
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd></dd>
<dd>Creates an options group from the values of the settings in this section.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-settings-SettingsGroup.html#method_get_setting">get_setting()</a>
<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-SettingsGroup.html#method_get_setting_value">get_setting_value()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd></dd>
<dd>Get a setting&#039;s value by its key.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-settings-SettingsGroup.html#method_set_setting_value">set_setting_value()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd></dd>
<dd>Set a setting&#039;s value by its key.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/footnotes-includes-settings-SettingsGroup.html#method_add_setting">add_setting()</a>
@ -298,7 +298,7 @@
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/referrers-and-tooltips/class-backlink-symbol-settings-group.php"><a href="files/src-includes-settings-referrers-and-tooltips-class-backlink-symbol-settings-group.html"><abbr title="src/includes/settings/referrers-and-tooltips/class-backlink-symbol-settings-group.php">class-backlink-symbol-settings-group.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/referrers-and-tooltips/class-backlinksymbolsettingsgroup.php"><a href="files/src-includes-settings-referrers-and-tooltips-class-backlinksymbolsettingsgroup.html"><abbr title="src/includes/settings/referrers-and-tooltips/class-backlinksymbolsettingsgroup.php">class-backlinksymbolsettingsgroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
@ -340,7 +340,7 @@
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/referrers-and-tooltips/class-backlink-symbol-settings-group.php"><a href="files/src-includes-settings-referrers-and-tooltips-class-backlink-symbol-settings-group.html"><abbr title="src/includes/settings/referrers-and-tooltips/class-backlink-symbol-settings-group.php">class-backlink-symbol-settings-group.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/referrers-and-tooltips/class-backlinksymbolsettingsgroup.php"><a href="files/src-includes-settings-referrers-and-tooltips-class-backlinksymbolsettingsgroup.html"><abbr title="src/includes/settings/referrers-and-tooltips/class-backlinksymbolsettingsgroup.php">class-backlinksymbolsettingsgroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">40</span>
@ -382,7 +382,7 @@
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/referrers-and-tooltips/class-backlink-symbol-settings-group.php"><a href="files/src-includes-settings-referrers-and-tooltips-class-backlink-symbol-settings-group.html"><abbr title="src/includes/settings/referrers-and-tooltips/class-backlink-symbol-settings-group.php">class-backlink-symbol-settings-group.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/referrers-and-tooltips/class-backlinksymbolsettingsgroup.php"><a href="files/src-includes-settings-referrers-and-tooltips-class-backlinksymbolsettingsgroup.html"><abbr title="src/includes/settings/referrers-and-tooltips/class-backlinksymbolsettingsgroup.php">class-backlinksymbolsettingsgroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">52</span>
@ -436,7 +436,7 @@ Convert setting data type from <code class="prettyprint">string</code> to <code
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/referrers-and-tooltips/class-backlink-symbol-settings-group.php"><a href="files/src-includes-settings-referrers-and-tooltips-class-backlink-symbol-settings-group.html"><abbr title="src/includes/settings/referrers-and-tooltips/class-backlink-symbol-settings-group.php">class-backlink-symbol-settings-group.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/referrers-and-tooltips/class-backlinksymbolsettingsgroup.php"><a href="files/src-includes-settings-referrers-and-tooltips-class-backlinksymbolsettingsgroup.html"><abbr title="src/includes/settings/referrers-and-tooltips/class-backlinksymbolsettingsgroup.php">class-backlinksymbolsettingsgroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">83</span>
@ -504,9 +504,9 @@ Convert from <code class="prettyprint">string</code> to <code class="prettyprint
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settings-group.php"><a href="files/src-includes-settings-class-settings-group.html"><abbr title="src/includes/settings/class-settings-group.php">class-settings-group.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">72</span>
<span class="phpdocumentor-element-found-in__line">76</span>
</aside>
@ -551,9 +551,9 @@ Convert from <code class="prettyprint">string</code> to <code class="prettyprint
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settings-group.php"><a href="files/src-includes-settings-class-settings-group.html"><abbr title="src/includes/settings/class-settings-group.php">class-settings-group.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">81</span>
<span class="phpdocumentor-element-found-in__line">85</span>
</aside>
@ -598,9 +598,9 @@ Convert from <code class="prettyprint">string</code> to <code class="prettyprint
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settings-group.php"><a href="files/src-includes-settings-class-settings-group.html"><abbr title="src/includes/settings/class-settings-group.php">class-settings-group.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">48</span>
<span class="phpdocumentor-element-found-in__line">52</span>
</aside>
@ -645,9 +645,9 @@ Convert from <code class="prettyprint">string</code> to <code class="prettyprint
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settings-group.php"><a href="files/src-includes-settings-class-settings-group.html"><abbr title="src/includes/settings/class-settings-group.php">class-settings-group.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">57</span>
<span class="phpdocumentor-element-found-in__line">61</span>
</aside>
@ -692,9 +692,9 @@ Convert from <code class="prettyprint">string</code> to <code class="prettyprint
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settings-group.php"><a href="files/src-includes-settings-class-settings-group.html"><abbr title="src/includes/settings/class-settings-group.php">class-settings-group.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">89</span>
<span class="phpdocumentor-element-found-in__line">93</span>
</aside>
@ -753,9 +753,9 @@ Convert from <code class="prettyprint">string</code> to <code class="prettyprint
<a href="classes/footnotes-includes-settings-SettingsGroup.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settings-group.php"><a href="files/src-includes-settings-class-settings-group.html"><abbr title="src/includes/settings/class-settings-group.php">class-settings-group.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">64</span>
<span class="phpdocumentor-element-found-in__line">68</span>
</aside>
@ -827,9 +827,9 @@ Convert from <code class="prettyprint">string</code> to <code class="prettyprint
<a href="classes/footnotes-includes-settings-SettingsGroup.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-group.php"><a href="files/src-includes-settings-class-settings-group.html"><abbr title="src/includes/settings/class-settings-group.php">class-settings-group.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">176</span>
<span class="phpdocumentor-element-found-in__line">183</span>
</aside>
@ -886,13 +886,14 @@ Convert from <code class="prettyprint">string</code> to <code class="prettyprint
<a href="classes/footnotes-includes-settings-SettingsGroup.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-group.php"><a href="files/src-includes-settings-class-settings-group.html"><abbr title="src/includes/settings/class-settings-group.php">class-settings-group.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">203</span>
<span class="phpdocumentor-element-found-in__line">216</span>
</aside>
<p class="phpdocumentor-summary">Creates an options group from the values of the settings in this section.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">get_options</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
@ -932,13 +933,14 @@ Convert from <code class="prettyprint">string</code> to <code class="prettyprint
<a href="classes/footnotes-includes-settings-SettingsGroup.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-group.php"><a href="files/src-includes-settings-class-settings-group.html"><abbr title="src/includes/settings/class-settings-group.php">class-settings-group.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">192</span>
<span class="phpdocumentor-element-found-in__line">201</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>
@ -989,13 +991,14 @@ Convert from <code class="prettyprint">string</code> to <code class="prettyprint
<a href="classes/footnotes-includes-settings-SettingsGroup.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-group.php"><a href="files/src-includes-settings-class-settings-group.html"><abbr title="src/includes/settings/class-settings-group.php">class-settings-group.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">216</span>
<span class="phpdocumentor-element-found-in__line">231</span>
</aside>
<p class="phpdocumentor-summary">Get 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">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>
@ -1046,13 +1049,14 @@ Convert from <code class="prettyprint">string</code> to <code class="prettyprint
<a href="classes/footnotes-includes-settings-SettingsGroup.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-group.php"><a href="files/src-includes-settings-class-settings-group.html"><abbr title="src/includes/settings/class-settings-group.php">class-settings-group.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">226</span>
<span class="phpdocumentor-element-found-in__line">246</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</span></code>
@ -1111,9 +1115,9 @@ Convert from <code class="prettyprint">string</code> to <code class="prettyprint
<a href="classes/footnotes-includes-settings-SettingsGroup.html#method_add_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-group.php"><a href="files/src-includes-settings-class-settings-group.html"><abbr title="src/includes/settings/class-settings-group.php">class-settings-group.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">128</span>
<span class="phpdocumentor-element-found-in__line">132</span>
</aside>
@ -1172,9 +1176,9 @@ Convert from <code class="prettyprint">string</code> to <code class="prettyprint
<a href="classes/footnotes-includes-settings-referrersandtooltips-BacklinkSymbolSettingsGroup.html#method_add_settings" 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/referrers-and-tooltips/class-backlink-symbol-settings-group.php"><a href="files/src-includes-settings-referrers-and-tooltips-class-backlink-symbol-settings-group.html"><abbr title="src/includes/settings/referrers-and-tooltips/class-backlink-symbol-settings-group.php">class-backlink-symbol-settings-group.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/referrers-and-tooltips/class-backlinksymbolsettingsgroup.php"><a href="files/src-includes-settings-referrers-and-tooltips-class-backlinksymbolsettingsgroup.html"><abbr title="src/includes/settings/referrers-and-tooltips/class-backlinksymbolsettingsgroup.php">class-backlinksymbolsettingsgroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">94</span>
<span class="phpdocumentor-element-found-in__line">96</span>
</aside>
@ -1231,9 +1235,9 @@ Convert from <code class="prettyprint">string</code> to <code class="prettyprint
<a href="classes/footnotes-includes-settings-SettingsGroup.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-group.php"><a href="files/src-includes-settings-class-settings-group.html"><abbr title="src/includes/settings/class-settings-group.php">class-settings-group.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
<span class="phpdocumentor-element-found-in__line">109</span>
</aside>
@ -1284,9 +1288,9 @@ Convert from <code class="prettyprint">string</code> to <code class="prettyprint
<a href="classes/footnotes-includes-settings-SettingsGroup.html#method_load_values" 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-group.php"><a href="files/src-includes-settings-class-settings-group.html"><abbr title="src/includes/settings/class-settings-group.php">class-settings-group.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">159</span>
<span class="phpdocumentor-element-found-in__line">163</span>
</aside>