1398 lines
68 KiB
HTML
1398 lines
68 KiB
HTML
<!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-customcss.html">customcss</a></li>
|
|
</ul>
|
|
|
|
<article class="phpdocumentor-element -class">
|
|
<h2 class="phpdocumentor-content__title">
|
|
CustomCSSSettingsSection
|
|
|
|
<span class="phpdocumentor-element__extends">
|
|
extends <a href="classes/footnotes-includes-settings-SettingsSection.html"><abbr title="\footnotes\includes\settings\SettingsSection">SettingsSection</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">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/custom-css/class-customcsssettingssection.php"><a href="files/src-includes-settings-custom-css-class-customcsssettingssection.html"><abbr title="src/includes/settings/custom-css/class-customcsssettingssection.php">class-customcsssettingssection.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">25</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Class defining plugin referrer and tooltips 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 -property -protected">
|
|
<a href="classes/footnotes-includes-settings-SettingsSection.html#property_options_group_slug">$options_group_slug</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Setting options group slug.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/footnotes-includes-settings-SettingsSection.html#property_section_slug">$section_slug</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Settings section slug.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/footnotes-includes-settings-customcss-CustomCSSSettingsSection.html#property_settings_groups">$settings_groups</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd>The groups of settings within this section.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/footnotes-includes-settings-SettingsSection.html#property_title">$title</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Settings section title.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/footnotes-includes-settings-customcss-CustomCSSSettingsSection.html#property_settings">$settings</a>
|
|
<span>
|
|
: <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-customcss-CustomCSSSettingsSection.html#method___construct">__construct()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Constructs the settings section.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/footnotes-includes-settings-SettingsSection.html#method_add_settings_fields">add_settings_fields()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/footnotes-includes-settings-SettingsSection.html#method_add_settings_section">add_settings_section()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/footnotes-includes-settings-SettingsSection.html#method_get_options">get_options()</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<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-SettingsSection.html#method_get_options_group_slug">get_options_group_slug()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/footnotes-includes-settings-SettingsSection.html#method_get_section_slug">get_section_slug()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Gets the settings section slug.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/footnotes-includes-settings-SettingsSection.html#method_get_setting">get_setting()</a>
|
|
<span>
|
|
: <a href="classes/footnotes-includes-settings-Setting.html"><abbr title="\footnotes\includes\settings\Setting">Setting</abbr></a>|null </span>
|
|
</dt>
|
|
<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>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Retrieve a setting'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>
|
|
<span>
|
|
: <a href="classes/footnotes-includes-settings-SettingsGroup.html"><abbr title="\footnotes\includes\settings\SettingsGroup">SettingsGroup</abbr></a>|null </span>
|
|
</dt>
|
|
<dd>Gets a settings groups from this section by its ID.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/footnotes-includes-settings-SettingsSection.html#method_get_title">get_title()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Gets the settings section title.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/footnotes-includes-settings-SettingsSection.html#method_load_options_group">load_options_group()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/footnotes-includes-settings-SettingsSection.html#method_set_setting_value">set_setting_value()</a>
|
|
<span>
|
|
: bool|null </span>
|
|
</dt>
|
|
<dd>Set a setting'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>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
<a href="classes/footnotes-includes-settings-customcss-CustomCSSSettingsSection.html#method_add_settings_groups">add_settings_groups()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Add the settings groups for this settings section.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
<a href="classes/footnotes-includes-settings-customcss-CustomCSSSettingsSection.html#method_load_dependencies">load_dependencies()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Load the required dependencies.</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-properties">
|
|
<h3 class="phpdocumentor-elements__header" id="properties">
|
|
Properties
|
|
<a href="classes/footnotes-includes-settings-customcss-CustomCSSSettingsSection.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-SettingsSection.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">
|
|
<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>
|
|
|
|
</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-SettingsSection.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">
|
|
<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>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Settings 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>
|
|
= <span class="phpdocumentor-signature__default-value">''</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_groups">
|
|
$settings_groups
|
|
<a href="classes/footnotes-includes-settings-customcss-CustomCSSSettingsSection.html#property_settings_groups" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/custom-css/class-customcsssettingssection.php"><a href="files/src-includes-settings-custom-css-class-customcsssettingssection.html"><abbr title="src/includes/settings/custom-css/class-customcsssettingssection.php">class-customcsssettingssection.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">33</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">The groups of settings within this section.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
|
<span class="phpdocumentor-signature__name">$settings_groups</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_title">
|
|
$title
|
|
<a href="classes/footnotes-includes-settings-SettingsSection.html#property_title" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<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>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Settings section title.</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">$title</span>
|
|
= <span class="phpdocumentor-signature__default-value">''</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
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_settings">
|
|
$settings
|
|
<a href="classes/footnotes-includes-settings-customcss-CustomCSSSettingsSection.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">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/custom-css/class-customcsssettingssection.php"><a href="files/src-includes-settings-custom-css-class-customcsssettingssection.html"><abbr title="src/includes/settings/custom-css/class-customcsssettingssection.php">class-customcsssettingssection.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">55</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">The plugin settings object.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</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</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-customcss-CustomCSSSettingsSection.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-customcss-CustomCSSSettingsSection.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/custom-css/class-customcsssettingssection.php"><a href="files/src-includes-settings-custom-css-class-customcsssettingssection.html"><abbr title="src/includes/settings/custom-css/class-customcsssettingssection.php">class-customcsssettingssection.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">44</span>
|
|
|
|
</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 </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 </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">string </span><span class="phpdocumentor-signature__argument__name">$title</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> </span><span class="phpdocumentor-signature__argument__name">$settings</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"><p>The slug of the settings section's options group.</p>
|
|
</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"><p>The slug of the settings section.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$title</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>The name of the settings section.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$settings</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>
|
|
—
|
|
|
|
|
|
</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-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-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>
|
|
|
|
</aside>
|
|
|
|
|
|
<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">mixed </span><span class="phpdocumentor-signature__argument__name">$component</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<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">mixed</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">void</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_add_settings_section">
|
|
add_settings_section()
|
|
<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-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>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">add_settings_section</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">void</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_get_options">
|
|
get_options()
|
|
<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-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">175</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<string|int, mixed></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>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>The options group.</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_get_options_group_slug">
|
|
get_options_group_slug()
|
|
<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-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>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">get_options_group_slug</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">string</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_get_section_slug">
|
|
get_section_slug()
|
|
<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-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>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Gets the settings section slug.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">get_section_slug</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</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>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">string</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>The section slug.</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_get_setting">
|
|
get_setting()
|
|
<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-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">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 </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"><abbr title="\footnotes\includes\settings\Settings::get_setting()">Settings::get_setting()</abbr></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>
|
|
—
|
|
|
|
|
|
</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-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-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">190</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Retrieve a setting'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 </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"><abbr title="\footnotes\includes\settings\Settings::get_setting_value()">Settings::get_setting_value()</abbr></span>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">mixed</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_get_settings_group">
|
|
get_settings_group()
|
|
<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-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>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Gets a settings groups from this section by its ID.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">get_settings_group</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$group_id</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/footnotes-includes-settings-SettingsGroup.html"><abbr title="\footnotes\includes\settings\SettingsGroup">SettingsGroup</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">$group_id</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>The ID of the settings group.</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-SettingsGroup.html"><abbr title="\footnotes\includes\settings\SettingsGroup">SettingsGroup</abbr></a>|null</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>The section group. 'None' if none found.</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_get_title">
|
|
get_title()
|
|
<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-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>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Gets the settings section title.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">get_title</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</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>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">string</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>The section title.</p>
|
|
</section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_load_options_group">
|
|
load_options_group()
|
|
<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-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>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">load_options_group</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">void</span>
|
|
—
|
|
|
|
|
|
</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-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-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">205</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Set a setting'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 </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 </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool|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>
|
|
<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"><abbr title="\footnotes\includes\settings\Settings::set_setting_value()">Settings::set_setting_value()</abbr></span>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool|null</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setting_section_callback">
|
|
setting_section_callback()
|
|
<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-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>
|
|
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">setting_section_callback</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">void</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_add_settings_groups">
|
|
add_settings_groups()
|
|
<a href="classes/footnotes-includes-settings-customcss-CustomCSSSettingsSection.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/custom-css/class-customcsssettingssection.php"><a href="files/src-includes-settings-custom-css-class-customcsssettingssection.html"><abbr title="src/includes/settings/custom-css/class-customcsssettingssection.php">class-customcsssettingssection.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">89</span>
|
|
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Add the settings groups for this settings section.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__name">add_settings_groups</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</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_add_settings_groups"><abbr title="\footnotes\includes\settings\SettingsSection::add_settings_groups()">SettingsSection::add_settings_groups()</abbr></a></span>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">void</span>
|
|
—
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_load_dependencies">
|
|
load_dependencies()
|
|
<a href="classes/footnotes-includes-settings-customcss-CustomCSSSettingsSection.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/custom-css/class-customcsssettingssection.php"><a href="files/src-includes-settings-custom-css-class-customcsssettingssection.html"><abbr title="src/includes/settings/custom-css/class-customcsssettingssection.php">class-customcsssettingssection.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">78</span>
|
|
|
|
</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 section:</p>
|
|
<ul>
|
|
<li>
|
|
<a href="classes/footnotes-includes-settings-SettingsSection.html"><abbr title="\footnotes\includes\settings\SettingsSection">SettingsSection</abbr></a>: defines a settings section; and</li>
|
|
<li>
|
|
<a href="classes/footnotes-includes-settings-customcss-CustomCSSSettingsGroup.html"><abbr title="\footnotes\includes\settings\customcss\CustomCSSSettingsGroup">CustomCSSSettingsGroup</abbr></a>.</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">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="classes/footnotes-includes-settings-SettingsSection.html#method_load_dependencies"><abbr title="\footnotes\includes\settings\SettingsSection::load_dependencies()">SettingsSection::load_dependencies()</abbr></a></span>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">void</span>
|
|
—
|
|
|
|
|
|
</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-customcss-CustomCSSSettingsSection.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>
|