3413 lines
209 KiB
HTML
3413 lines
209 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-general.html">general</a></li>
|
||
</ul>
|
||
|
||
<article class="phpdocumentor-element -class">
|
||
<h2 class="phpdocumentor-content__title">
|
||
ReferenceContainerSettingsGroup
|
||
|
||
<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">
|
||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">23</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Class defining the reference container 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-general-ReferenceContainerSettingsGroup.html#constant_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED">BACKLINKS_COLUMN_MAX_WIDTH_ENABLED</a>
|
||
<span>
|
||
= array('key' => 'footnotes_inputfield_backlinks_column_max_width_enabled', 'name' => 'Set Backlinks Column Max. Width', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox') </span>
|
||
</dt>
|
||
<dd>Settings container key to enable a max width for the backlinks column.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR">BACKLINKS_COLUMN_MAX_WIDTH_SCALAR</a>
|
||
<span>
|
||
= array('key' => 'footnotes_inputfield_backlinks_column_max_width_scalar', 'name' => 'Backlinks Column Width', 'default_value' => 140, 'type' => 'number', 'input_type' => 'number', 'input_max' => 500, 'input_min' => 0, 'enabled_by' => self::BACKLINKS_COLUMN_MAX_WIDTH_ENABLED) </span>
|
||
</dt>
|
||
<dd>Settings container key for the backlinks column max width scalar.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_BACKLINKS_COLUMN_MAX_WIDTH_UNIT">BACKLINKS_COLUMN_MAX_WIDTH_UNIT</a>
|
||
<span>
|
||
= array('key' => 'footnotes_inputfield_backlinks_column_max_width_unit', 'name' => 'Backlinks Column Width Unit', 'description' => 'Absolute width in pixels doesn't need to be accurate to the tenth, but relative width in `rem` or `em` may.', 'default_value' => 'px', 'type' => 'string', 'input_type' => 'select', 'input_options' => ootnotesincludessettingsSetting::WIDTH_UNIT_OPTIONS, 'enabled_by' => self::BACKLINKS_COLUMN_MAX_WIDTH_ENABLED) </span>
|
||
</dt>
|
||
<dd>Settings container key for the backlinks column max width unit.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_BACKLINKS_COLUMN_WIDTH_ENABLED">BACKLINKS_COLUMN_WIDTH_ENABLED</a>
|
||
<span>
|
||
= array('key' => 'footnotes_inputfield_backlinks_column_width_enabled', 'name' => 'Set Backlinks Column Width', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox') </span>
|
||
</dt>
|
||
<dd>Settings container key to enable the backlinks column width.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_BACKLINKS_COLUMN_WIDTH_SCALAR">BACKLINKS_COLUMN_WIDTH_SCALAR</a>
|
||
<span>
|
||
= array('key' => 'footnotes_inputfield_backlinks_column_width_scalar', 'name' => 'Backlinks Column Width', 'default_value' => 50, 'type' => 'number', 'input_type' => 'number', 'input_max' => 500, 'input_min' => 0, 'enabled_by' => self::BACKLINKS_COLUMN_WIDTH_ENABLED) </span>
|
||
</dt>
|
||
<dd>Settings container key for the backlinks column width scalar.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_BACKLINKS_COLUMN_WIDTH_UNIT">BACKLINKS_COLUMN_WIDTH_UNIT</a>
|
||
<span>
|
||
= array('key' => 'footnotes_inputfield_backlinks_column_width_unit', 'name' => 'Backlinks Column Width Unit', 'description' => 'Absolute width in pixels doesn't need to be accurate to the tenth, but relative width in `rem` or `em` may.', 'default_value' => 'px', 'type' => 'string', 'input_type' => 'select', 'input_options' => ootnotesincludessettingsSetting::WIDTH_UNIT_OPTIONS, 'enabled_by' => self::BACKLINKS_COLUMN_WIDTH_ENABLED) </span>
|
||
</dt>
|
||
<dd>Settings container key for the backlinks column width unit.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_BACKLINKS_LINE_BREAKS_ENABLED">BACKLINKS_LINE_BREAKS_ENABLED</a>
|
||
<span>
|
||
= array('key' => 'footnotes_inputfield_backlinks_line_breaks_enabled', 'name' => 'Stack Backlinks When Enumerating', 'description' => 'This option adds a line break before each added backlink when identical footnotes are combined.', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox') </span>
|
||
</dt>
|
||
<dd>Settings container key to enable line breaks between backlinks.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_BACKLINKS_SEPARATOR_CUSTOM">BACKLINKS_SEPARATOR_CUSTOM</a>
|
||
<span>
|
||
= array('key' => 'footnotes_inputfield_backlinks_separator_custom', 'name' => 'Custom Backlink Separator Symbol', 'description' => 'Your input overrides the selection.', 'type' => 'string', 'input_type' => 'text', 'enabled_by' => self::BACKLINKS_SEPARATOR_ENABLED) </span>
|
||
</dt>
|
||
<dd>Settings container key for a custom backlink separator.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_BACKLINKS_SEPARATOR_ENABLED">BACKLINKS_SEPARATOR_ENABLED</a>
|
||
<span>
|
||
= array('key' => 'footnotes_inputfield_backlinks_separator_enabled', 'name' => 'Add a Separator When Enumerating Backlinks', 'default_value' => true, 'type' => 'boolean', 'input_type' => 'checkbox') </span>
|
||
</dt>
|
||
<dd>Settings container key to enable the presence of a backlink separator.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_BACKLINKS_SEPARATOR_OPTION">BACKLINKS_SEPARATOR_OPTION</a>
|
||
<span>
|
||
= array('key' => 'footnotes_inputfield_backlinks_separator_option', 'name' => 'Backlink Separator Symbol', 'default_value' => 'comma', 'type' => 'string', 'input_type' => 'select', 'input_options' => array(
|
||
// Unicode character names are conventionally uppercase.
|
||
'comma' => ',',
|
||
'semicolon' => ';',
|
||
'en_dash' => '–',
|
||
), 'enabled_by' => self::BACKLINKS_SEPARATOR_ENABLED, 'overridden_by' => self::BACKLINKS_SEPARATOR_CUSTOM) </span>
|
||
</dt>
|
||
<dd>Settings container key for the backlink separator options.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_BACKLINKS_TERMINATOR_CUSTOM">BACKLINKS_TERMINATOR_CUSTOM</a>
|
||
<span>
|
||
= array('key' => 'footnotes_inputfield_backlinks_terminator_custom', 'name' => 'Custom Backlink Terminator Symbol', 'description' => 'Your input overrides the selection.', 'type' => 'string', 'input_type' => 'text', 'enabled_by' => self::BACKLINKS_TERMINATOR_ENABLED) </span>
|
||
</dt>
|
||
<dd>Settings container key for a custom backlink terminator.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_BACKLINKS_TERMINATOR_ENABLED">BACKLINKS_TERMINATOR_ENABLED</a>
|
||
<span>
|
||
= array('key' => 'footnotes_inputfield_backlinks_terminator_enabled', 'name' => 'Add a Terminal Punctuation to Backlinks', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox') </span>
|
||
</dt>
|
||
<dd>Settings container key to enable the presence of a backlink terminator.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_BACKLINKS_TERMINATOR_OPTION">BACKLINKS_TERMINATOR_OPTION</a>
|
||
<span>
|
||
= array('key' => 'footnotes_inputfield_backlinks_terminator_option', 'name' => 'Backlink Terminator Symbol', 'default_value' => 'period', 'type' => 'string', 'input_type' => 'select', 'input_options' => array(
|
||
'period' => '.',
|
||
// Unicode 1.0 name of RIGHT PARENTHESIS (represented as a left parenthesis in right-to-left scripts).
|
||
'parenthesis' => ')',
|
||
'colon' => ':',
|
||
), 'enabled_by' => self::BACKLINKS_TERMINATOR_ENABLED, 'overridden_by' => self::BACKLINKS_TERMINATOR_CUSTOM) </span>
|
||
</dt>
|
||
<dd>Settings container key for the backlink terminator options.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_FOOTNOTE_SECTION_SHORTCODE">FOOTNOTE_SECTION_SHORTCODE</a>
|
||
<span>
|
||
= array('key' => 'footnotes_inputfield_section_shortcode', 'name' => 'Footnote Section Shortcode', 'description' => 'If present in the content, any shortcode in this text box will delimit a section terminated by a reference container.', 'default_value' => '[[/footnotesection]]', 'type' => 'string', 'input_type' => 'text') </span>
|
||
</dt>
|
||
<dd>Settings container key for the footnote section shortcode.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_FOOTNOTE_URL_WRAP_ENABLED">FOOTNOTE_URL_WRAP_ENABLED</a>
|
||
<span>
|
||
= array('key' => 'footnote_inputfield_url_wrap_enabled', 'name' => 'Allow URLs to Line-Wrap Anywhere', 'description' => 'Unicode-conformant browsers don't need this fix.', 'default_value' => true, 'type' => 'boolean', 'input_type' => 'checkbox') </span>
|
||
</dt>
|
||
<dd>Settings container key for URL wrap option.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_FOOTNOTES_PAGE_LAYOUT_SUPPORT">FOOTNOTES_PAGE_LAYOUT_SUPPORT</a>
|
||
<span>
|
||
= array('key' => 'footnotes_inputfield_page_layout_support', 'name' => 'Apply Basic Responsive Page Layout', 'description' => 'Most themes don't need this fix.', 'default_value' => 'none', 'type' => 'string', 'input_type' => 'select', 'input_options' => array('none' => 'No', 'reference-container' => 'to the reference container exclusively', 'entry-content' => 'to the div element starting below the post title', 'main-content' => 'to the main element including the post title')) </span>
|
||
</dt>
|
||
<dd>Settings container key for basic responsive page layout support options.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE">FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE</a>
|
||
<span>
|
||
= array('key' => 'footnotes_inputfield_reference_container_script_mode', 'name' => 'Script Mode', 'description' => 'The plain JavaScript mode will enable hard links with configurable scroll offset.', 'default_value' => 'jquery', 'type' => 'string', 'input_type' => 'select', 'input_options' => array('jquery' => 'jQuery', 'js' => 'plain JavaScript')) </span>
|
||
</dt>
|
||
<dd>Settings container key to select the script mode for the reference container.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_GROUP_ID">GROUP_ID</a>
|
||
<span>
|
||
= 'reference-container' </span>
|
||
</dt>
|
||
<dd>Setting group ID.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_GROUP_NAME">GROUP_NAME</a>
|
||
<span>
|
||
= 'Reference Container' </span>
|
||
</dt>
|
||
<dd>Setting group name.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_LINK_ELEMENT_ENABLED">LINK_ELEMENT_ENABLED</a>
|
||
<span>
|
||
= array('key' => 'footnote_inputfield_link_element_enabled', 'name' => 'Use the Link Element for Referrers and Backlinks', 'description' => 'The link element is needed to apply the theme's link color. If the link element is not desired for styling, a simple span is used instead when the above is unchecked.', 'default_value' => true, 'type' => 'boolean', 'input_type' => 'checkbox') </span>
|
||
</dt>
|
||
<dd>Settings container key for the link element option.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE">REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE</a>
|
||
<span>
|
||
= array('key' => 'footnotes_inputfield_reference_container_3column_layout_enable', 'name' => 'Backlink Symbol in an Extra Column', 'description' => 'This legacy layout is available if identical footnotes are not combined.', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox') </span>
|
||
</dt>
|
||
<dd>Settings container key to enable the legacy layout of the reference container.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE">REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE</a>
|
||
<span>
|
||
= array('key' => 'footnotes_inputfield_reference_container_backlink_symbol_enable', 'name' => 'Display a Backlink Symbol', 'description' => 'Please choose or input the symbol at the top of the next dashboard tab.', 'default_value' => true, 'type' => 'boolean', 'input_type' => 'checkbox') </span>
|
||
</dt>
|
||
<dd>Settings container key to enable the display of a backlink symbol.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH">REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH</a>
|
||
<span>
|
||
= array('key' => 'footnotes_inputfield_reference_container_backlink_symbol_switch', 'name' => 'Append Instead of Prepend Symbol', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox') </span>
|
||
</dt>
|
||
<dd>Settings container key to get the backlink symbol switch side.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_REFERENCE_CONTAINER_BOTTOM_MARGIN">REFERENCE_CONTAINER_BOTTOM_MARGIN</a>
|
||
<span>
|
||
= array('key' => 'footnotes_inputfield_reference_container_bottom_margin', 'name' => 'Bottom Margin', 'description' => 'pixels; may be negative', 'default_value' => 0, 'type' => 'integer', 'input_type' => 'number', 'input_max' => 500, 'input_min' => -500) </span>
|
||
</dt>
|
||
<dd>Settings container key for reference container bottom margin.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_REFERENCE_CONTAINER_COLLAPSE">REFERENCE_CONTAINER_COLLAPSE</a>
|
||
<span>
|
||
= array('key' => 'footnote_inputfield_collapse_references', 'name' => 'Collapse by Default', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox') </span>
|
||
</dt>
|
||
<dd>Settings container key to collapse the reference container by default.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER">REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER</a>
|
||
<span>
|
||
= array('key' => 'footnotes_inputfield_reference_container_label_bottom_border', 'name' => 'Border Under the Heading', 'default_value' => true, 'type' => 'boolean', 'input_type' => 'checkbox') </span>
|
||
</dt>
|
||
<dd>Settings container key to enable the reference container label bottom border.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_REFERENCE_CONTAINER_LABEL_ELEMENT">REFERENCE_CONTAINER_LABEL_ELEMENT</a>
|
||
<span>
|
||
= array('key' => 'footnote_inputfield_references_label', 'name' => 'Heading's HTML Element', 'default_value' => 'p', 'type' => 'string', 'input_type' => 'select', 'input_options' => ootnotesincludessettingsSetting::TEXT_ELEMENT_OPTIONS) </span>
|
||
</dt>
|
||
<dd>Settings container key for the reference container label element.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_REFERENCE_CONTAINER_NAME">REFERENCE_CONTAINER_NAME</a>
|
||
<span>
|
||
= array('key' => 'footnote_inputfield_references_label', 'name' => 'Reference Container Title', 'default_value' => 'References', 'type' => 'string', 'input_type' => 'text') </span>
|
||
</dt>
|
||
<dd>Settings container key for the label of the reference container.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_REFERENCE_CONTAINER_POSITION">REFERENCE_CONTAINER_POSITION</a>
|
||
<span>
|
||
= array('key' => 'footnote_inputfield_reference_container_place', 'name' => 'Container Position', 'description' => 'Where the container should be placed on the page. To use the position or section shortcode, please set the position to: at the end of the post', 'default_value' => 'post_end', 'type' => 'string', 'input_type' => 'select', 'input_options' => array('post_end' => 'at the end of the post', 'widget' => 'in the widget area', 'footer' => 'in the footer')) </span>
|
||
</dt>
|
||
<dd>Settings container key for the position of the reference container.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_REFERENCE_CONTAINER_POSITION_SHORTCODE">REFERENCE_CONTAINER_POSITION_SHORTCODE</a>
|
||
<span>
|
||
= array('key' => 'footnote_inputfield_reference_container_position_shortcode', 'name' => 'Position Shortcode', 'description' => 'If present in the content, any shortcode in this text box will be replaced with the reference container.', 'default_value' => '[[references]]', 'type' => 'string', 'input_type' => 'text') </span>
|
||
</dt>
|
||
<dd>Settings container key for reference container position shortcode.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE">REFERENCE_CONTAINER_ROW_BORDERS_ENABLE</a>
|
||
<span>
|
||
= array('key' => 'footnotes_inputfield_reference_container_row_borders_enable', 'name' => 'Borders Around the Table Rows', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox') </span>
|
||
</dt>
|
||
<dd>Settings container key to enable reference container table row borders.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_REFERENCE_CONTAINER_START_PAGE_ENABLE">REFERENCE_CONTAINER_START_PAGE_ENABLE</a>
|
||
<span>
|
||
= array('key' => 'footnotes_inputfield_reference_container_start_page_enable', 'name' => 'Display on Start Page Too', 'default_value' => true, 'type' => 'boolean', 'input_type' => 'checkbox') </span>
|
||
</dt>
|
||
<dd>Settings container key to not display the reference container on the homepage.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_REFERENCE_CONTAINER_TOP_MARGIN">REFERENCE_CONTAINER_TOP_MARGIN</a>
|
||
<span>
|
||
= array('key' => 'footnotes_inputfield_reference_container_top_margin', 'name' => 'Top Margin', 'description' => 'pixels; may be negative', 'default_value' => 24, 'type' => 'integer', 'input_type' => 'number', 'input_max' => 500, 'input_min' => -500) </span>
|
||
</dt>
|
||
<dd>Settings container key for reference container top margin.</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>
|
||
: 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>
|
||
: 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>
|
||
: array<string|int, mixed> </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>
|
||
: array<string|int, mixed> </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>
|
||
: <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>
|
||
: 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>
|
||
: 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>
|
||
: 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-SettingsGroup.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-SettingsGroup.html#method_get_setting_value">get_setting_value()</a>
|
||
<span>
|
||
: mixed </span>
|
||
</dt>
|
||
<dd>Get a setting's value by its key.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||
<a href="classes/footnotes-includes-settings-SettingsGroup.html#method_set_setting_value">set_setting_value()</a>
|
||
<span>
|
||
: bool </span>
|
||
</dt>
|
||
<dd>Set a setting's value by its key.</dd>
|
||
|
||
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
||
<a href="classes/footnotes-includes-settings-SettingsGroup.html#method_add_setting">add_setting()</a>
|
||
<span>
|
||
: <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-general-ReferenceContainerSettingsGroup.html#method_add_settings">add_settings()</a>
|
||
<span>
|
||
: 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>
|
||
: 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>
|
||
: 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-general-ReferenceContainerSettingsGroup.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_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED">
|
||
BACKLINKS_COLUMN_MAX_WIDTH_ENABLED
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">597</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key to enable a max width for the backlinks column.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">BACKLINKS_COLUMN_MAX_WIDTH_ENABLED</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnotes_inputfield_backlinks_column_max_width_enabled', 'name' => 'Set Backlinks Column Max. Width', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox')</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"><abbr title="\footnotes\includes\settings\general\BACKLINKS_COLUMN_MAX_WIDTH_SCALAR">BACKLINKS_COLUMN_MAX_WIDTH_SCALAR</abbr></span>
|
||
|
||
|
||
</dd>
|
||
<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\general\BACKLINKS_COLUMN_MAX_WIDTH_UNIT">BACKLINKS_COLUMN_MAX_WIDTH_UNIT</abbr></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.1.4</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">boolean</code>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR">
|
||
BACKLINKS_COLUMN_MAX_WIDTH_SCALAR
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">617</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key for the backlinks column max width scalar.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">BACKLINKS_COLUMN_MAX_WIDTH_SCALAR</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnotes_inputfield_backlinks_column_max_width_scalar', 'name' => 'Backlinks Column Width', 'default_value' => 140, 'type' => 'number', 'input_type' => 'number', 'input_max' => 500, 'input_min' => 0, 'enabled_by' => self::BACKLINKS_COLUMN_MAX_WIDTH_ENABLED)</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"><abbr title="\footnotes\includes\settings\general\BACKLINKS_COLUMN_MAX_WIDTH_ENABLED">BACKLINKS_COLUMN_MAX_WIDTH_ENABLED</abbr></span>
|
||
|
||
|
||
</dd>
|
||
<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\general\BACKLINKS_COLUMN_MAX_WIDTH_UNIT">BACKLINKS_COLUMN_MAX_WIDTH_UNIT</abbr></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.1.4</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>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_BACKLINKS_COLUMN_MAX_WIDTH_UNIT">
|
||
BACKLINKS_COLUMN_MAX_WIDTH_UNIT
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_BACKLINKS_COLUMN_MAX_WIDTH_UNIT" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">640</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key for the backlinks column max width unit.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">BACKLINKS_COLUMN_MAX_WIDTH_UNIT</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnotes_inputfield_backlinks_column_max_width_unit', 'name' => 'Backlinks Column Width Unit', 'description' => 'Absolute width in pixels doesn't need to be accurate to the tenth, but relative width in `rem` or `em` may.', 'default_value' => 'px', 'type' => 'string', 'input_type' => 'select', 'input_options' => ootnotesincludessettingsSetting::WIDTH_UNIT_OPTIONS, 'enabled_by' => self::BACKLINKS_COLUMN_MAX_WIDTH_ENABLED)</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"><abbr title="\footnotes\includes\settings\general\BACKLINKS_COLUMN_MAX_WIDTH_ENABLED">BACKLINKS_COLUMN_MAX_WIDTH_ENABLED</abbr></span>
|
||
|
||
|
||
</dd>
|
||
<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\general\BACKLINKS_COLUMN_MAX_WIDTH_SCALAR">BACKLINKS_COLUMN_MAX_WIDTH_SCALAR</abbr></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.1.4</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>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_BACKLINKS_COLUMN_WIDTH_ENABLED">
|
||
BACKLINKS_COLUMN_WIDTH_ENABLED
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_BACKLINKS_COLUMN_WIDTH_ENABLED" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">530</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key to enable the backlinks column width.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">BACKLINKS_COLUMN_WIDTH_ENABLED</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnotes_inputfield_backlinks_column_width_enabled', 'name' => 'Set Backlinks Column Width', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox')</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"><abbr title="\footnotes\includes\settings\general\BACKLINKS_COLUMN_WIDTH_SCALAR">BACKLINKS_COLUMN_WIDTH_SCALAR</abbr></span>
|
||
|
||
|
||
</dd>
|
||
<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\general\BACKLINKS_COLUMN_WIDTH_UNIT">BACKLINKS_COLUMN_WIDTH_UNIT</abbr></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.1.4</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">boolean</code>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_BACKLINKS_COLUMN_WIDTH_SCALAR">
|
||
BACKLINKS_COLUMN_WIDTH_SCALAR
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_BACKLINKS_COLUMN_WIDTH_SCALAR" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">550</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key for the backlinks column width scalar.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">BACKLINKS_COLUMN_WIDTH_SCALAR</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnotes_inputfield_backlinks_column_width_scalar', 'name' => 'Backlinks Column Width', 'default_value' => 50, 'type' => 'number', 'input_type' => 'number', 'input_max' => 500, 'input_min' => 0, 'enabled_by' => self::BACKLINKS_COLUMN_WIDTH_ENABLED)</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"><abbr title="\footnotes\includes\settings\general\BACKLINKS_COLUMN_WIDTH_ENABLED">BACKLINKS_COLUMN_WIDTH_ENABLED</abbr></span>
|
||
|
||
|
||
</dd>
|
||
<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\general\BACKLINKS_COLUMN_WIDTH_UNIT">BACKLINKS_COLUMN_WIDTH_UNIT</abbr></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.1.4</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>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_BACKLINKS_COLUMN_WIDTH_UNIT">
|
||
BACKLINKS_COLUMN_WIDTH_UNIT
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_BACKLINKS_COLUMN_WIDTH_UNIT" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">573</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key for the backlinks column width unit.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">BACKLINKS_COLUMN_WIDTH_UNIT</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnotes_inputfield_backlinks_column_width_unit', 'name' => 'Backlinks Column Width Unit', 'description' => 'Absolute width in pixels doesn't need to be accurate to the tenth, but relative width in `rem` or `em` may.', 'default_value' => 'px', 'type' => 'string', 'input_type' => 'select', 'input_options' => ootnotesincludessettingsSetting::WIDTH_UNIT_OPTIONS, 'enabled_by' => self::BACKLINKS_COLUMN_WIDTH_ENABLED)</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"><abbr title="\footnotes\includes\settings\general\BACKLINKS_COLUMN_WIDTH_ENABLED">BACKLINKS_COLUMN_WIDTH_ENABLED</abbr></span>
|
||
|
||
|
||
</dd>
|
||
<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\general\BACKLINKS_COLUMN_WIDTH_SCALAR">BACKLINKS_COLUMN_WIDTH_SCALAR</abbr></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.1.4</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>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_BACKLINKS_LINE_BREAKS_ENABLED">
|
||
BACKLINKS_LINE_BREAKS_ENABLED
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_BACKLINKS_LINE_BREAKS_ENABLED" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">663</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key to enable line breaks between backlinks.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">BACKLINKS_LINE_BREAKS_ENABLED</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnotes_inputfield_backlinks_line_breaks_enabled', 'name' => 'Stack Backlinks When Enumerating', 'description' => 'This option adds a line break before each added backlink when identical footnotes are combined.', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox')</span>
|
||
</code>
|
||
|
||
|
||
<section class="phpdocumentor-description"><p>Whether a <code class="prettyprint"><br /></code> HTML element is inserted.</p>
|
||
</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.1.4</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">boolean</code>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_BACKLINKS_SEPARATOR_CUSTOM">
|
||
BACKLINKS_SEPARATOR_CUSTOM
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_BACKLINKS_SEPARATOR_CUSTOM" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">438</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key for a custom backlink separator.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">BACKLINKS_SEPARATOR_CUSTOM</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnotes_inputfield_backlinks_separator_custom', 'name' => 'Custom Backlink Separator Symbol', 'description' => 'Your input overrides the selection.', 'type' => 'string', 'input_type' => 'text', 'enabled_by' => self::BACKLINKS_SEPARATOR_ENABLED)</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"><abbr title="\footnotes\includes\settings\general\BACKLINKS_SEPARATOR_ENABLED">BACKLINKS_SEPARATOR_ENABLED</abbr></span>
|
||
|
||
|
||
</dd>
|
||
<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\general\BACKLINKS_SEPARATOR_OPTION">BACKLINKS_SEPARATOR_OPTION</abbr></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.1.4</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>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_BACKLINKS_SEPARATOR_ENABLED">
|
||
BACKLINKS_SEPARATOR_ENABLED
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_BACKLINKS_SEPARATOR_ENABLED" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">390</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key to enable the presence of a backlink separator.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">BACKLINKS_SEPARATOR_ENABLED</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnotes_inputfield_backlinks_separator_enabled', 'name' => 'Add a Separator When Enumerating Backlinks', 'default_value' => true, 'type' => 'boolean', 'input_type' => 'checkbox')</span>
|
||
</code>
|
||
|
||
|
||
<section class="phpdocumentor-description"><p>Backlink separators and terminators are often not preferred, but a choice
|
||
should be provided along with the ability to customize.</p>
|
||
</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"><abbr title="\footnotes\includes\settings\general\BACKLINKS_SEPARATOR_OPTION">BACKLINKS_SEPARATOR_OPTION</abbr></span>
|
||
|
||
|
||
</dd>
|
||
<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\general\BACKLINKS_SEPARATOR_CUSTOM">BACKLINKS_SEPARATOR_CUSTOM</abbr></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.1.4</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">boolean</code>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_BACKLINKS_SEPARATOR_OPTION">
|
||
BACKLINKS_SEPARATOR_OPTION
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_BACKLINKS_SEPARATOR_OPTION" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">410</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key for the backlink separator options.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">BACKLINKS_SEPARATOR_OPTION</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnotes_inputfield_backlinks_separator_option', 'name' => 'Backlink Separator Symbol', 'default_value' => 'comma', 'type' => 'string', 'input_type' => 'select', 'input_options' => array(
|
||
// Unicode character names are conventionally uppercase.
|
||
'comma' => ',',
|
||
'semicolon' => ';',
|
||
'en_dash' => '–',
|
||
), 'enabled_by' => self::BACKLINKS_SEPARATOR_ENABLED, 'overridden_by' => self::BACKLINKS_SEPARATOR_CUSTOM)</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"><abbr title="\footnotes\includes\settings\general\BACKLINKS_SEPARATOR_ENABLED">BACKLINKS_SEPARATOR_ENABLED</abbr></span>
|
||
|
||
|
||
</dd>
|
||
<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\general\BACKLINKS_SEPARATOR_CUSTOM">BACKLINKS_SEPARATOR_CUSTOM</abbr></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.1.4</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>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_BACKLINKS_TERMINATOR_CUSTOM">
|
||
BACKLINKS_TERMINATOR_CUSTOM
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_BACKLINKS_TERMINATOR_CUSTOM" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">508</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key for a custom backlink terminator.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">BACKLINKS_TERMINATOR_CUSTOM</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnotes_inputfield_backlinks_terminator_custom', 'name' => 'Custom Backlink Terminator Symbol', 'description' => 'Your input overrides the selection.', 'type' => 'string', 'input_type' => 'text', 'enabled_by' => self::BACKLINKS_TERMINATOR_ENABLED)</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"><abbr title="\footnotes\includes\settings\general\BACKLINKS_TERMINATOR_ENABLED">BACKLINKS_TERMINATOR_ENABLED</abbr></span>
|
||
|
||
|
||
</dd>
|
||
<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\general\BACKLINKS_TERMINATOR_OPTION">BACKLINKS_TERMINATOR_OPTION</abbr></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.1.4</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>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_BACKLINKS_TERMINATOR_ENABLED">
|
||
BACKLINKS_TERMINATOR_ENABLED
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_BACKLINKS_TERMINATOR_ENABLED" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">460</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key to enable the presence of a backlink terminator.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">BACKLINKS_TERMINATOR_ENABLED</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnotes_inputfield_backlinks_terminator_enabled', 'name' => 'Add a Terminal Punctuation to Backlinks', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox')</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"><abbr title="\footnotes\includes\settings\general\BACKLINKS_TERMINATOR_OPTION">BACKLINKS_TERMINATOR_OPTION</abbr></span>
|
||
|
||
|
||
</dd>
|
||
<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\general\BACKLINKS_TERMINATOR_CUSTOM">BACKLINKS_TERMINATOR_CUSTOM</abbr></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.1.4</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">boolean</code>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_BACKLINKS_TERMINATOR_OPTION">
|
||
BACKLINKS_TERMINATOR_OPTION
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_BACKLINKS_TERMINATOR_OPTION" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">480</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key for the backlink terminator options.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">BACKLINKS_TERMINATOR_OPTION</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnotes_inputfield_backlinks_terminator_option', 'name' => 'Backlink Terminator Symbol', 'default_value' => 'period', 'type' => 'string', 'input_type' => 'select', 'input_options' => array(
|
||
'period' => '.',
|
||
// Unicode 1.0 name of RIGHT PARENTHESIS (represented as a left parenthesis in right-to-left scripts).
|
||
'parenthesis' => ')',
|
||
'colon' => ':',
|
||
), 'enabled_by' => self::BACKLINKS_TERMINATOR_ENABLED, 'overridden_by' => self::BACKLINKS_TERMINATOR_CUSTOM)</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"><abbr title="\footnotes\includes\settings\general\BACKLINKS_TERMINATOR_ENABLED">BACKLINKS_TERMINATOR_ENABLED</abbr></span>
|
||
|
||
|
||
</dd>
|
||
<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\general\BACKLINKS_TERMINATOR_CUSTOM">BACKLINKS_TERMINATOR_CUSTOM</abbr></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.1.4</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>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_FOOTNOTE_SECTION_SHORTCODE">
|
||
FOOTNOTE_SECTION_SHORTCODE
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_FOOTNOTE_SECTION_SHORTCODE" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">185</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key for the footnote section shortcode.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">FOOTNOTE_SECTION_SHORTCODE</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnotes_inputfield_section_shortcode', 'name' => 'Footnote Section Shortcode', 'description' => 'If present in the content, any shortcode in this text box will delimit a section terminated by a reference container.', 'default_value' => '[[/footnotesection]]', 'type' => 'string', 'input_type' => 'text')</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.7.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>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_FOOTNOTE_URL_WRAP_ENABLED">
|
||
FOOTNOTE_URL_WRAP_ENABLED
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_FOOTNOTE_URL_WRAP_ENABLED" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">291</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key for URL wrap option.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">FOOTNOTE_URL_WRAP_ENABLED</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnote_inputfield_url_wrap_enabled', 'name' => 'Allow URLs to Line-Wrap Anywhere', 'description' => 'Unicode-conformant browsers don't need this fix.', 'default_value' => true, 'type' => 'boolean', 'input_type' => 'checkbox')</span>
|
||
</code>
|
||
|
||
|
||
<section class="phpdocumentor-description"><p>This is made optional because it causes weird line breaks. Unicode-compliant
|
||
browsers break URLs at slashes.</p>
|
||
</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.1.6</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">boolean</code>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_FOOTNOTES_PAGE_LAYOUT_SUPPORT">
|
||
FOOTNOTES_PAGE_LAYOUT_SUPPORT
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_FOOTNOTES_PAGE_LAYOUT_SUPPORT" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">263</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key for basic responsive page layout support options.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">FOOTNOTES_PAGE_LAYOUT_SUPPORT</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnotes_inputfield_page_layout_support', 'name' => 'Apply Basic Responsive Page Layout', 'description' => 'Most themes don't need this fix.', 'default_value' => 'none', 'type' => 'string', 'input_type' => 'select', 'input_options' => array('none' => 'No', 'reference-container' => 'to the reference container exclusively', 'entry-content' => 'to the div element starting below the post title', 'main-content' => 'to the main element including the post title'))</span>
|
||
</code>
|
||
|
||
|
||
<section class="phpdocumentor-description"><p>Whether to concatenate an additional stylesheet.</p>
|
||
</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.1.4</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>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE">
|
||
FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">122</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key to select the script mode for the reference container.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnotes_inputfield_reference_container_script_mode', 'name' => 'Script Mode', 'description' => 'The plain JavaScript mode will enable hard links with configurable scroll offset.', 'default_value' => 'jquery', 'type' => 'string', 'input_type' => 'select', 'input_options' => array('jquery' => 'jQuery', 'js' => 'plain JavaScript'))</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.5.6</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>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_GROUP_ID">
|
||
GROUP_ID
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_GROUP_ID" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<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">'reference-container'</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-general-ReferenceContainerSettingsGroup.html#constant_GROUP_NAME" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<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">'Reference Container'</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_LINK_ELEMENT_ENABLED">
|
||
LINK_ELEMENT_ENABLED
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_LINK_ELEMENT_ENABLED" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">682</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key for the link element option.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">LINK_ELEMENT_ENABLED</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnote_inputfield_link_element_enabled', 'name' => 'Use the Link Element for Referrers and Backlinks', 'description' => 'The link element is needed to apply the theme's link color. If the link element is not desired for styling, a simple span is used instead when the above is unchecked.', 'default_value' => true, 'type' => 'boolean', 'input_type' => 'checkbox')</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.1.4</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">boolean</code>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE">
|
||
REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">347</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key to enable the legacy layout of the reference container.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnotes_inputfield_reference_container_3column_layout_enable', 'name' => 'Backlink Symbol in an Extra Column', 'description' => 'This legacy layout is available if identical footnotes are not combined.', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox')</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.1.1</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">boolean</code>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE">
|
||
REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">310</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key to enable the display of a backlink symbol.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnotes_inputfield_reference_container_backlink_symbol_enable', 'name' => 'Display a Backlink Symbol', 'description' => 'Please choose or input the symbol at the top of the next dashboard tab.', 'default_value' => true, 'type' => 'boolean', 'input_type' => 'checkbox')</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.1.1</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">boolean</code>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH">
|
||
REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">329</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key to get the backlink symbol switch side.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnotes_inputfield_reference_container_backlink_symbol_switch', 'name' => 'Append Instead of Prepend Symbol', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox')</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.1.1</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">boolean</code>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_REFERENCE_CONTAINER_BOTTOM_MARGIN">
|
||
REFERENCE_CONTAINER_BOTTOM_MARGIN
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_REFERENCE_CONTAINER_BOTTOM_MARGIN" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">241</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key for reference container bottom margin.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">int</span>
|
||
<span class="phpdocumentor-signature__name">REFERENCE_CONTAINER_BOTTOM_MARGIN</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnotes_inputfield_reference_container_bottom_margin', 'name' => 'Bottom Margin', 'description' => 'pixels; may be negative', 'default_value' => 0, 'type' => 'integer', 'input_type' => 'number', 'input_max' => 500, 'input_min' => -500)</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.3.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">int</code> to <code class="prettyprint">array</code>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_REFERENCE_CONTAINER_COLLAPSE">
|
||
REFERENCE_CONTAINER_COLLAPSE
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_REFERENCE_CONTAINER_COLLAPSE" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">105</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key to collapse the reference container by default.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">bool</span>
|
||
<span class="phpdocumentor-signature__name">REFERENCE_CONTAINER_COLLAPSE</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnote_inputfield_collapse_references', 'name' => 'Collapse by Default', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox')</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">boolean</code>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER">
|
||
REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">87</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key to enable the reference container label bottom border.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnotes_inputfield_reference_container_label_bottom_border', 'name' => 'Border Under the Heading', 'default_value' => true, 'type' => 'boolean', 'input_type' => 'checkbox')</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.2.5</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">boolean</code>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_REFERENCE_CONTAINER_LABEL_ELEMENT">
|
||
REFERENCE_CONTAINER_LABEL_ELEMENT
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_REFERENCE_CONTAINER_LABEL_ELEMENT" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">68</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key for the reference container label element.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">REFERENCE_CONTAINER_LABEL_ELEMENT</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnote_inputfield_references_label', 'name' => 'Heading's HTML Element', 'default_value' => 'p', 'type' => 'string', 'input_type' => 'select', 'input_options' => ootnotesincludessettingsSetting::TEXT_ELEMENT_OPTIONS)</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.2.5</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>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_REFERENCE_CONTAINER_NAME">
|
||
REFERENCE_CONTAINER_NAME
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_REFERENCE_CONTAINER_NAME" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">51</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key for the label of the reference container.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">REFERENCE_CONTAINER_NAME</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnote_inputfield_references_label', 'name' => 'Reference Container Title', 'default_value' => 'References', 'type' => 'string', 'input_type' => 'text')</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>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_REFERENCE_CONTAINER_POSITION">
|
||
REFERENCE_CONTAINER_POSITION
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_REFERENCE_CONTAINER_POSITION" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">144</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key for the position of the reference container.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">REFERENCE_CONTAINER_POSITION</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnote_inputfield_reference_container_place', 'name' => 'Container Position', 'description' => 'Where the container should be placed on the page. To use the position or section shortcode, please set the position to: at the end of the post', 'default_value' => 'post_end', 'type' => 'string', 'input_type' => 'select', 'input_options' => array('post_end' => 'at the end of the post', 'widget' => 'in the widget area', 'footer' => 'in the footer'))</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>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_REFERENCE_CONTAINER_POSITION_SHORTCODE">
|
||
REFERENCE_CONTAINER_POSITION_SHORTCODE
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_REFERENCE_CONTAINER_POSITION_SHORTCODE" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">167</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key for reference container position shortcode.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">REFERENCE_CONTAINER_POSITION_SHORTCODE</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnote_inputfield_reference_container_position_shortcode', 'name' => 'Position Shortcode', 'description' => 'If present in the content, any shortcode in this text box will be replaced with the reference container.', 'default_value' => '[[references]]', 'type' => 'string', 'input_type' => 'text')</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.2.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>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE">
|
||
REFERENCE_CONTAINER_ROW_BORDERS_ENABLE
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">366</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key to enable reference container table row borders.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">REFERENCE_CONTAINER_ROW_BORDERS_ENABLE</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnotes_inputfield_reference_container_row_borders_enable', 'name' => 'Borders Around the Table Rows', 'default_value' => false, 'type' => 'boolean', 'input_type' => 'checkbox')</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.2.10</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">boolean</code>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_REFERENCE_CONTAINER_START_PAGE_ENABLE">
|
||
REFERENCE_CONTAINER_START_PAGE_ENABLE
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_REFERENCE_CONTAINER_START_PAGE_ENABLE" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">204</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key to not display the reference container on the homepage.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">array<string|int, mixed></span>
|
||
<span class="phpdocumentor-signature__name">REFERENCE_CONTAINER_START_PAGE_ENABLE</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnotes_inputfield_reference_container_start_page_enable', 'name' => 'Display on Start Page Too', 'default_value' => true, 'type' => 'boolean', 'input_type' => 'checkbox')</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.1.1</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">Refere\nceContainerSettingsGroup</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">boolean</code>.</p>
|
||
</section>
|
||
|
||
</dd>
|
||
</dl>
|
||
|
||
</article>
|
||
<article class="phpdocumentor-element -constant -public ">
|
||
<h4 class="phpdocumentor-element__name" id="constant_REFERENCE_CONTAINER_TOP_MARGIN">
|
||
REFERENCE_CONTAINER_TOP_MARGIN
|
||
<a href="classes/footnotes-includes-settings-general-ReferenceContainerSettingsGroup.html#constant_REFERENCE_CONTAINER_TOP_MARGIN" 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/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">221</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Settings container key for reference container top margin.</p>
|
||
|
||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__type">int</span>
|
||
<span class="phpdocumentor-signature__name">REFERENCE_CONTAINER_TOP_MARGIN</span>
|
||
= <span class="phpdocumentor-signature__default-value">array('key' => 'footnotes_inputfield_reference_container_top_margin', 'name' => 'Top Margin', 'description' => 'pixels; may be negative', 'default_value' => 24, 'type' => 'integer', 'input_type' => 'number', 'input_max' => 500, 'input_min' => -500)</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.3.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">int</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-general-ReferenceContainerSettingsGroup.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">
|
||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">76</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-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">
|
||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">85</span>
|
||
|
||
</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">
|
||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">52</span>
|
||
|
||
</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<string|int, mixed></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">
|
||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">61</span>
|
||
|
||
</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<string|int, mixed></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">
|
||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">93</span>
|
||
|
||
</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-general-ReferenceContainerSettingsGroup.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">
|
||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">68</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"><a href="classes/footnotes-includes-Settings.html"><abbr title="\footnotes\includes\Settings">Settings</abbr></a> </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>
|
||
—
|
||
|
||
|
||
</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">
|
||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">183</span>
|
||
|
||
</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> </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>
|
||
—
|
||
|
||
|
||
</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">
|
||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">216</span>
|
||
|
||
</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">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<string|int, mixed></span>
|
||
—
|
||
|
||
|
||
</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">
|
||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">201</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Retrieve a setting by its key.</p>
|
||
|
||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||
<span class="phpdocumentor-signature__visibility">public</span>
|
||
<span class="phpdocumentor-signature__name">get_setting</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </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>
|
||
—
|
||
|
||
|
||
</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">
|
||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">231</span>
|
||
|
||
</aside>
|
||
|
||
<p class="phpdocumentor-summary">Get 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">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"><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>
|
||
—
|
||
|
||
|
||
</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">
|
||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">246</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</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>
|
||
—
|
||
|
||
|
||
</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">
|
||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">132</span>
|
||
|
||
</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<string, mixed> </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<string, mixed></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>
|
||
—
|
||
<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-general-ReferenceContainerSettingsGroup.html#method_add_settings" class="headerlink"><i class="fas fa-link"></i></a>
|
||
</h4>
|
||
<aside class="phpdocumentor-element-found-in">
|
||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/general/class-referencecontainersettingsgroup.php"><a href="files/src-includes-settings-general-class-referencecontainersettingsgroup.html"><abbr title="src/includes/settings/general/class-referencecontainersettingsgroup.php">class-referencecontainersettingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">696</span>
|
||
|
||
</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<string|int, mixed>|false </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<string|int, mixed>|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>
|
||
—
|
||
|
||
|
||
</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">
|
||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">109</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 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>
|
||
—
|
||
|
||
|
||
</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">
|
||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/settings/class-settingsgroup.php"><a href="files/src-includes-settings-class-settingsgroup.html"><abbr title="src/includes/settings/class-settingsgroup.php">class-settingsgroup.php</abbr></a></abbr>
|
||
:
|
||
<span class="phpdocumentor-element-found-in__line">163</span>
|
||
|
||
</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<string, mixed>|false </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<string, mixed>|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>
|
||
—
|
||
|
||
|
||
</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-general-ReferenceContainerSettingsGroup.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>
|