Rumperuu/footnotes
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
This repository has been archived on 2023-08-16. You can view files and clone it, but cannot push or open issues or pull requests.
footnotes/docs/classes/footnotes-includes-settings-referrersandtooltips-BacklinkSymbolSettingsGroup.html

1439 lines
75 KiB
HTML
Raw Normal View History

docs: update documentation
2021-08-09 10:27:33 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Documentation</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -four phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h3 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/default.html"><abbr title="\">Global</abbr></a></h3>
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h4>
<ul class="phpdocumentor-list">
<li><a href="namespaces/footnotes-admin.html"><abbr title="\footnotes\admin">admin</abbr></a></li>
<li><a href="namespaces/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
<li><a href="namespaces/footnotes-general.html"><abbr title="\footnotes\general">general</abbr></a></li>
</ul>
</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>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="namespaces/footnotes.html">footnotes</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/footnotes-includes.html">includes</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/footnotes-includes-settings.html">settings</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/footnotes-includes-settings-referrersandtooltips.html">referrersandtooltips</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
BacklinkSymbolSettingsGroup
<span class="phpdocumentor-element__extends">
extends <a href="classes/footnotes-includes-settings-SettingsGroup.html"><abbr title="\footnotes\includes\settings\SettingsGroup">SettingsGroup</abbr></a>
</span>
<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>
<aside class="phpdocumentor-element-found-in">
docs: update documentation
2021-08-09 10:49:15 +00:00
<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>
docs: update documentation
2021-08-09 10:27:33 +00:00
:
<span class="phpdocumentor-element-found-in__line">23</span>
</aside>
<p class="phpdocumentor-summary">Class defining the backlink symbol settings.</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
</dd>
</dl>
<h3 id="toc">
Table of Contents
<a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/footnotes-includes-settings-referrersandtooltips-BacklinkSymbolSettingsGroup.html#constant_GROUP_ID">GROUP_ID</a>
<span>
&nbsp;= &#039;backlink-symbol&#039; </span>
</dt>
<dd>Setting group ID.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/footnotes-includes-settings-referrersandtooltips-BacklinkSymbolSettingsGroup.html#constant_GROUP_NAME">GROUP_NAME</a>
<span>
&nbsp;= &#039;Backlink Symbol&#039; </span>
</dt>
<dd>Setting group name.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/footnotes-includes-settings-referrersandtooltips-BacklinkSymbolSettingsGroup.html#constant_HYPERLINK_ARROW">HYPERLINK_ARROW</a>
<span>
&nbsp;= array(&#039;key&#039; =&gt; &#039;footnote_inputfield_custom_hyperlink_symbol&#039;, &#039;name&#039; =&gt; &#039;Select the Backlink Symbol&#039;, &#039;description&#039; =&gt; &#039;This symbol is used in the reference container. But this setting pre-existed under this tab and cannot be moved to another one.&#039;, &#039;default_value&#039; =&gt; 0, &#039;type&#039; =&gt; &#039;number&#039;, &#039;input_type&#039; =&gt; &#039;select&#039;, &#039;input_options&#039; =&gt; array(&#039;&amp;#8593;&#039;, &#039;&amp;#8613;&#039;, &#039;&amp;#8607;&#039;, &#039;&amp;#8617;&#039;, &#039;&amp;#8626;&#039;, &#039;&amp;#8629;&#039;, &#039;&amp;#8657;&#039;, &#039;&amp;#8673;&#039;, &#039;&amp;#8679;&#039;, &#039;&amp;#65514;&#039;), &#039;overridden_by&#039; =&gt; self::HYPERLINK_ARROW_USER_DEFINED) </span>
</dt>
<dd>Settings container key for the backlink symbol selection.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/footnotes-includes-settings-referrersandtooltips-BacklinkSymbolSettingsGroup.html#constant_HYPERLINK_ARROW_USER_DEFINED">HYPERLINK_ARROW_USER_DEFINED</a>
<span>
&nbsp;= array(&#039;key&#039; =&gt; &#039;footnote_inputfield_custom_hyperlink_symbol_user&#039;, &#039;name&#039; =&gt; &#039;Input the Backlink Symbol&#039;, &#039;description&#039; =&gt; &#039;Your input overrides the selection.&#039;, &#039;type&#039; =&gt; &#039;string&#039;, &#039;input_type&#039; =&gt; &#039;text&#039;) </span>
</dt>
<dd>Settings container key for the user-defined backlink symbol.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/footnotes-includes-settings-SettingsGroup.html#property_options_group_slug">$options_group_slug</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Setting options group slug.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/footnotes-includes-settings-SettingsGroup.html#property_section_slug">$section_slug</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Setting section slug.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/footnotes-includes-settings-SettingsGroup.html#property_setting_classes">$setting_classes</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>The setting classes.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/footnotes-includes-settings-SettingsGroup.html#property_settings">$settings</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>The settings in this group.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/footnotes-includes-settings-SettingsGroup.html#property_settings_obj">$settings_obj</a>
<span>
&nbsp;: <a href="classes/footnotes-includes-Settings.html"><abbr title="\footnotes\includes\Settings">Settings</abbr></a> </span>
</dt>
<dd>The plugin settings object.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-settings-SettingsGroup.html#method___construct">__construct()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Constructs the settings section.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-settings-SettingsGroup.html#method_add_settings_fields">add_settings_fields()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Adds all the settings fields for this group to the admin. dashboard.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-settings-SettingsGroup.html#method_get_options">get_options()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
docs: update documentation
2021-08-09 10:49:15 +00:00
<dd>Creates an options group from the values of the settings in this section.</dd>
docs: update documentation
2021-08-09 10:27:33 +00:00
<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>
docs: update documentation
2021-08-09 10:49:15 +00:00
<dd>Retrieve a setting by its key.</dd>
docs: update documentation
2021-08-09 10:27:33 +00:00
<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>
docs: update documentation
2021-08-09 10:49:15 +00:00
<dd>Get a setting&#039;s value by its key.</dd>
docs: update documentation
2021-08-09 10:27:33 +00:00
<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>
docs: update documentation
2021-08-09 10:49:15 +00:00
<dd>Set a setting&#039;s value by its key.</dd>
docs: update documentation
2021-08-09 10:27:33 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/footnotes-includes-settings-SettingsGroup.html#method_add_setting">add_setting()</a>
<span>
&nbsp;: <a href="classes/footnotes-includes-settings-Setting.html"><abbr title="\footnotes\includes\settings\Setting">Setting</abbr></a> </span>
</dt>
<dd>Constructs settings from the provided details.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/footnotes-includes-settings-referrersandtooltips-BacklinkSymbolSettingsGroup.html#method_add_settings">add_settings()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Add the settings for this settings group.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/footnotes-includes-settings-SettingsGroup.html#method_load_dependencies">load_dependencies()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Load the required dependencies.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/footnotes-includes-settings-SettingsGroup.html#method_load_values">load_values()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Load the values for this settings group.</dd>
</dl>
<section class="phpdocumentor-constants">
<h3 class="phpdocumentor-elements__header" id="constants">
Constants
<a href="classes/footnotes-includes-settings-referrersandtooltips-BacklinkSymbolSettingsGroup.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_GROUP_ID">
GROUP_ID
<a href="classes/footnotes-includes-settings-referrersandtooltips-BacklinkSymbolSettingsGroup.html#constant_GROUP_ID" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
docs: update documentation
2021-08-09 10:49:15 +00:00
<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>
docs: update documentation
2021-08-09 10:27:33 +00:00
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">Setting group ID.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">GROUP_ID</span>
= <span class="phpdocumentor-signature__default-value">&#039;backlink-symbol&#039;</span>
</code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_GROUP_NAME">
GROUP_NAME
<a href="classes/footnotes-includes-settings-referrersandtooltips-BacklinkSymbolSettingsGroup.html#constant_GROUP_NAME" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
docs: update documentation
2021-08-09 10:49:15 +00:00
<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>
docs: update documentation
2021-08-09 10:27:33 +00:00
:
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<p class="phpdocumentor-summary">Setting group name.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">GROUP_NAME</span>
= <span class="phpdocumentor-signature__default-value">&#039;Backlink Symbol&#039;</span>
</code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_HYPERLINK_ARROW">
HYPERLINK_ARROW
<a href="classes/footnotes-includes-settings-referrersandtooltips-BacklinkSymbolSettingsGroup.html#constant_HYPERLINK_ARROW" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
docs: update documentation
2021-08-09 10:49:15 +00:00
<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>
docs: update documentation
2021-08-09 10:27:33 +00:00
:
<span class="phpdocumentor-element-found-in__line">52</span>
</aside>
<p class="phpdocumentor-summary">Settings container key for the backlink symbol selection.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">HYPERLINK_ARROW</span>
= <span class="phpdocumentor-signature__default-value">array(&#039;key&#039; =&gt; &#039;footnote_inputfield_custom_hyperlink_symbol&#039;, &#039;name&#039; =&gt; &#039;Select the Backlink Symbol&#039;, &#039;description&#039; =&gt; &#039;This symbol is used in the reference container. But this setting pre-existed under this tab and cannot be moved to another one.&#039;, &#039;default_value&#039; =&gt; 0, &#039;type&#039; =&gt; &#039;number&#039;, &#039;input_type&#039; =&gt; &#039;select&#039;, &#039;input_options&#039; =&gt; array(&#039;&amp;#8593;&#039;, &#039;&amp;#8613;&#039;, &#039;&amp;#8607;&#039;, &#039;&amp;#8617;&#039;, &#039;&amp;#8626;&#039;, &#039;&amp;#8629;&#039;, &#039;&amp;#8657;&#039;, &#039;&amp;#8673;&#039;, &#039;&amp;#8679;&#039;, &#039;&amp;#65514;&#039;), &#039;overridden_by&#039; =&gt; self::HYPERLINK_ARROW_USER_DEFINED)</span>
</code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
<section class="phpdocumentor-description"><p>Move from <code class="prettyprint">Settings</code> to <code class="prettyprint">ReferenceContainerSettingsGroup</code>.
Convert from <code class="prettyprint">string</code> to <code class="prettyprint">array</code>.
Convert setting data type from <code class="prettyprint">string</code> to <code class="prettyprint">int</code>.</p>
</section>
</dd>
</dl>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_HYPERLINK_ARROW_USER_DEFINED">
HYPERLINK_ARROW_USER_DEFINED
<a href="classes/footnotes-includes-settings-referrersandtooltips-BacklinkSymbolSettingsGroup.html#constant_HYPERLINK_ARROW_USER_DEFINED" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
docs: update documentation
2021-08-09 10:49:15 +00:00
<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>
docs: update documentation
2021-08-09 10:27:33 +00:00
:
<span class="phpdocumentor-element-found-in__line">83</span>
</aside>
<p class="phpdocumentor-summary">Settings container key for the user-defined backlink symbol.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">HYPERLINK_ARROW_USER_DEFINED</span>
= <span class="phpdocumentor-signature__default-value">array(&#039;key&#039; =&gt; &#039;footnote_inputfield_custom_hyperlink_symbol_user&#039;, &#039;name&#039; =&gt; &#039;Input the Backlink Symbol&#039;, &#039;description&#039; =&gt; &#039;Your input overrides the selection.&#039;, &#039;type&#039; =&gt; &#039;string&#039;, &#039;input_type&#039; =&gt; &#039;text&#039;)</span>
</code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
<section class="phpdocumentor-description"><p>Move from <code class="prettyprint">Settings</code> to <code class="prettyprint">BacklinkSymbolSettingsGroup</code>.
Convert from <code class="prettyprint">string</code> to <code class="prettyprint">array</code>.</p>
</section>
</dd>
</dl>
</article>
</section>
<section class="phpdocumentor-properties">
<h3 class="phpdocumentor-elements__header" id="properties">
Properties
<a href="classes/footnotes-includes-settings-referrersandtooltips-BacklinkSymbolSettingsGroup.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_options_group_slug">
$options_group_slug
<a href="classes/footnotes-includes-settings-SettingsGroup.html#property_options_group_slug" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
docs: update documentation
2021-08-09 10:49:15 +00:00
<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>
docs: update documentation
2021-08-09 10:27:33 +00:00
:
docs: update documentation
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">76</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
</aside>
<p class="phpdocumentor-summary">Setting options group slug.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$options_group_slug</span>
</code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_section_slug">
$section_slug
<a href="classes/footnotes-includes-settings-SettingsGroup.html#property_section_slug" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
docs: update documentation
2021-08-09 10:49:15 +00:00
<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>
docs: update documentation
2021-08-09 10:27:33 +00:00
:
docs: update documentation
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">85</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
</aside>
<p class="phpdocumentor-summary">Setting section slug.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$section_slug</span>
</code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_setting_classes">
$setting_classes
<a href="classes/footnotes-includes-settings-SettingsGroup.html#property_setting_classes" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
docs: update documentation
2021-08-09 10:49:15 +00:00
<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>
docs: update documentation
2021-08-09 10:27:33 +00:00
:
docs: update documentation
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">52</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
</aside>
<p class="phpdocumentor-summary">The setting classes.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">$setting_classes</span>
</code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_settings">
$settings
<a href="classes/footnotes-includes-settings-SettingsGroup.html#property_settings" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
docs: update documentation
2021-08-09 10:49:15 +00:00
<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>
docs: update documentation
2021-08-09 10:27:33 +00:00
:
docs: update documentation
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">61</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
</aside>
<p class="phpdocumentor-summary">The settings in this group.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">$settings</span>
</code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_settings_obj">
$settings_obj
<a href="classes/footnotes-includes-settings-SettingsGroup.html#property_settings_obj" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
docs: update documentation
2021-08-09 10:49:15 +00:00
<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>
docs: update documentation
2021-08-09 10:27:33 +00:00
:
docs: update documentation
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">93</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
</aside>
<p class="phpdocumentor-summary">The plugin settings object.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type"><a href="classes/footnotes-includes-Settings.html"><abbr title="\footnotes\includes\Settings">Settings</abbr></a></span>
<span class="phpdocumentor-signature__name">$settings_obj</span>
</code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>private</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
</dd>
</dl>
</article>
</section>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/footnotes-includes-settings-referrersandtooltips-BacklinkSymbolSettingsGroup.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method___construct">
__construct()
<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">
docs: update documentation
2021-08-09 10:49:15 +00:00
<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>
docs: update documentation
2021-08-09 10:27:33 +00:00
:
docs: update documentation
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">68</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
</aside>
<p class="phpdocumentor-summary">Constructs the settings section.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$options_group_slug</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$section_slug</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/footnotes-includes-Settings.html"><abbr title="\footnotes\includes\Settings">Settings</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$settings_obj</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$options_group_slug</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$section_slug</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$settings_obj</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/footnotes-includes-Settings.html"><abbr title="\footnotes\includes\Settings">Settings</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_add_settings_fields">
add_settings_fields()
<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">
docs: update documentation
2021-08-09 10:49:15 +00:00
<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>
docs: update documentation
2021-08-09 10:27:33 +00:00
:
docs: update documentation
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">183</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
</aside>
<p class="phpdocumentor-summary">Adds all the settings fields for this group to the admin. dashboard.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">add_settings_fields</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/footnotes-admin-layout-SettingsPage.html"><abbr title="\footnotes\admin\layout\SettingsPage">SettingsPage</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$component</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$component</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/footnotes-admin-layout-SettingsPage.html"><abbr title="\footnotes\admin\layout\SettingsPage">SettingsPage</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The admin. dashboard settings page.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_get_options">
get_options()
<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">
docs: update documentation
2021-08-09 10:49:15 +00:00
<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>
docs: update documentation
2021-08-09 10:27:33 +00:00
:
docs: update documentation
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">216</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
</aside>
docs: update documentation
2021-08-09 10:49:15 +00:00
<p class="phpdocumentor-summary">Creates an options group from the values of the settings in this section.</p>
docs: update documentation
2021-08-09 10:27:33 +00:00
<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>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/footnotes-includes-settings-SettingsSection.html#method_get_options"><abbr title="\footnotes\includes\settings\SettingsSection::get_options()">SettingsSection::get_options()</abbr></a></span>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_get_setting">
get_setting()
<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">
docs: update documentation
2021-08-09 10:49:15 +00:00
<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>
docs: update documentation
2021-08-09 10:27:33 +00:00
:
docs: update documentation
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">201</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
</aside>
docs: update documentation
2021-08-09 10:49:15 +00:00
<p class="phpdocumentor-summary">Retrieve a setting by its key.</p>
docs: update documentation
2021-08-09 10:27:33 +00:00
<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>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$setting_key</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/footnotes-includes-Settings.html#method_get_setting"><abbr title="\footnotes\includes\Settings::get_setting()">Settings::get_setting()</abbr></a></span>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<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>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_get_setting_value">
get_setting_value()
<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">
docs: update documentation
2021-08-09 10:49:15 +00:00
<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>
docs: update documentation
2021-08-09 10:27:33 +00:00
:
docs: update documentation
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">231</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
</aside>
docs: update documentation
2021-08-09 10:49:15 +00:00
<p class="phpdocumentor-summary">Get a setting&#039;s value by its key.</p>
docs: update documentation
2021-08-09 10:27:33 +00:00
<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>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$setting_key</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/footnotes-includes-Settings.html#method_get_setting_value"><abbr title="\footnotes\includes\Settings::get_setting_value()">Settings::get_setting_value()</abbr></a></span>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_set_setting_value">
set_setting_value()
<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">
docs: update documentation
2021-08-09 10:49:15 +00:00
<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>
docs: update documentation
2021-08-09 10:27:33 +00:00
:
docs: update documentation
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">246</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
</aside>
docs: update documentation
2021-08-09 10:49:15 +00:00
<p class="phpdocumentor-summary">Set a setting&#039;s value by its key.</p>
docs: update documentation
2021-08-09 10:27:33 +00:00
<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>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$setting_key</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/footnotes-includes-Settings.html#method_set_setting_value"><abbr title="\footnotes\includes\Settings::set_setting_value()">Settings::set_setting_value()</abbr></a></span>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_add_setting">
add_setting()
<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">
docs: update documentation
2021-08-09 10:49:15 +00:00
<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>
docs: update documentation
2021-08-09 10:27:33 +00:00
:
docs: update documentation
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">132</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
</aside>
<p class="phpdocumentor-summary">Constructs settings from the provided details.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">add_setting</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$setting</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></span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$setting</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The setting details.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/footnotes-includes-settings-Setting.html"><abbr title="\footnotes\includes\settings\Setting">Setting</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"><p>The constructed setting object.</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_add_settings">
add_settings()
<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">
docs: update documentation
2021-08-09 10:49:15 +00:00
<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>
docs: update documentation
2021-08-09 10:27:33 +00:00
:
docs: update documentation
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">96</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
</aside>
<p class="phpdocumentor-summary">Add the settings for this settings group.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">add_settings</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;|false&nbsp;</span><span class="phpdocumentor-signature__argument__name">$options</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$options</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;|false</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Saved values for the settings in this group. 'False' if none exist.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/footnotes-includes-settings-SettingsGroup.html#method_add_settings"><abbr title="\footnotes\includes\settings\SettingsGroup::add_settings()">SettingsGroup::add_settings()</abbr></a></span>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_load_dependencies">
load_dependencies()
<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">
docs: update documentation
2021-08-09 10:49:15 +00:00
<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>
docs: update documentation
2021-08-09 10:27:33 +00:00
:
docs: update documentation
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">109</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
</aside>
<p class="phpdocumentor-summary">Load the required dependencies.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<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 provide the settings for this plugin:</p>
<ul>
<li>
<a href="classes/footnotes-includes-settings-Setting.html"><abbr title="\footnotes\includes\settings\Setting">Setting</abbr></a>: defines individual settings.</li>
</ul>
</section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_load_values">
load_values()
<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">
docs: update documentation
2021-08-09 10:49:15 +00:00
<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>
docs: update documentation
2021-08-09 10:27:33 +00:00
:
docs: update documentation
2021-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">163</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
</aside>
<p class="phpdocumentor-summary">Load the values for this settings group.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">load_values</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string, mixed&gt;|false&nbsp;</span><span class="phpdocumentor-signature__argument__name">$options</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$options</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string, mixed&gt;|false</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Saved values for the settings in this group. 'False' if none exist.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
</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>Remove settings from options group when not found.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
</section>
<script type="text/javascript">
function loadExternalCodeSnippets(line) {
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
var src = pre.getAttribute('data-src').replace( /\\/g, '/');
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
var language = 'php';
var code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
}
else if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
}
else {
code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
}
}
};
xhr.send(null);
});
}
var modals = document.querySelectorAll("[data-modal]");
modals.forEach(function (trigger) {
trigger.addEventListener("click", function (event) {
//event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippets(trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
</script>
</article>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
</div>
<a href="classes/footnotes-includes-settings-referrersandtooltips-BacklinkSymbolSettingsGroup.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>
Reference in a new issue Copy permalink