This repository has been archived on 2023-08-16. You can view files and clone it, but cannot push or open issues or pull requests.
footnotes/docs/classes/Footnotes-Layout-Settings.html

3939 lines
202 KiB
HTML
Raw Normal View History

<!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 href="https://fonts.googleapis.com/css2?family=Source+Sans+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" />
<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="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/js/all.min.js" integrity="sha256-0vuk8LXoyrmCjp1f0O300qo1M75ZQyhH9X3J6d+scmk=" crossorigin="anonymous"></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>
2021-04-26 22:06:10 +00:00
</section>
2021-04-26 22:06:10 +00:00
<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-footnotesincludes.html"><abbr title="\footnotes\footnotesincludes">footnotesincludes</abbr></a></li>
<li><a href="packages/footnotes-footnotesadmin.html"><abbr title="\footnotes\footnotesadmin">footnotesadmin</abbr></a></li>
<li><a href="packages/footnotes-footnotespublic.html"><abbr title="\footnotes\footnotespublic">footnotespublic</abbr></a></li>
</ul>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
</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="packages/footnotes.html">footnotes</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
Footnotes_Layout_Settings
<span class="phpdocumentor-element__extends">
extends <a href="classes/Footnotes-Layout-Engine.html"><abbr title="\Footnotes_Layout_Engine">Footnotes_Layout_Engine</abbr></a>
</span>
2021-04-26 22:06:10 +00:00
<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">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">51</span>
</aside>
<p class="phpdocumentor-summary">Displays and handles all Settings of the Plugin.</p>
<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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h3 id="toc">
Table of Contents
<a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/Footnotes-Layout-Engine.html#property_a_arr_sections">$a_arr_sections</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Stores all Sections for the child sub page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/Footnotes-Layout-Engine.html#property_a_str_sub_page_hook">$a_str_sub_page_hook</a>
<span>
&nbsp;: null|string </span>
</dt>
<dd>Stores the Hook connection string for the child sub page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Settings.html#method_amp_compat">amp_compat()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Displays the AMP compatibility mode option.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Settings.html#method_custom_css">custom_css()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Displays the Custom CSS box.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Settings.html#method_custom_css_migration">custom_css_migration()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Displays transitional legacy Custom CSS box.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Settings.html#method_custom_css_new">custom_css_new()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Displays the new Custom CSS box.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Engine.html#method_description">description()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Output the Description of a section. May be overwritten in any section.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Engine.html#method_display_content">display_content()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Displays the content of specific sub page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Settings.html#method_donate">donate()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Displays all Donate button to support the developers.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Settings.html#method_excerpts">excerpts()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Displays the footnotes in excerpt setting.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Settings.html#method_get_priority">get_priority()</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Returns a Priority index. Lower numbers have a higher Priority.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Settings.html#method_hard_links">hard_links()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Displays all options for the fragment identifier configuration.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Settings.html#method_Help">Help()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Displays a short introduction to the Plugin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Settings.html#method_hyperlink_arrow">hyperlink_arrow()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Displays all settings for the backlink symbol.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Settings.html#method_label_solution">label_solution()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Displays the setting for the input label issue solution.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Settings.html#method_lookup_hooks">lookup_hooks()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Displays available Hooks to look for Footnote short codes.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Settings.html#method_love">love()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Displays all settings for &#039;I love Footnotes&#039;.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Settings.html#method_mouseover_box">mouseover_box()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Displays enabled status for the footnotes mouse-over box.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Settings.html#method_mouseover_box_appearance">mouseover_box_appearance()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Displays style settings for the footnotes mouse-over box.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Settings.html#method_mouseover_box_dimensions">mouseover_box_dimensions()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Displays dimensions setting for the footnotes mouse-over box.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Settings.html#method_mouseover_box_position">mouseover_box_position()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Displays position settings for the footnotes mouse-over box.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Settings.html#method_mouseover_box_text">mouseover_box_text()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Displays dedicated tooltip text settings for the footnotes mouse-over box.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Settings.html#method_mouseover_box_timing">mouseover_box_timing()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Displays timing settings for the footnotes mouse-over box.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Settings.html#method_mouseover_box_truncation">mouseover_box_truncation()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Displays truncation settings for the footnotes mouse-over box.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Settings.html#method_numbering">numbering()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Displays all options for the footnotes numbering.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Settings.html#method_reference_container">reference_container()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Displays all settings for the reference container.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Engine.html#method_register_sections">register_sections()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Registers all sections for a sub page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Engine.html#method_register_sub_page">register_sub_page()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Registers a sub page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Settings.html#method_scrolling">scrolling()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Displays all options for the scrolling behavior.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Settings.html#method_start_end">start_end()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Displays all options for the footnotes start and end tag short codes.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Layout-Settings.html#method_superscript">superscript()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Displays all settings for the footnote referrers.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/Footnotes-Layout-Engine.html#method_add_checkbox">add_checkbox()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Returns the html tag for an input [type = checkbox].</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/Footnotes-Layout-Engine.html#method_add_color_selection">add_color_selection()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Returns the html tag for an input [type = text] with color selection class.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/Footnotes-Layout-Engine.html#method_add_label">add_label()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Returns the html tag for an input/select label.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/Footnotes-Layout-Engine.html#method_add_line_space">add_line_space()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Returns a line break to have a space between two lines.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/Footnotes-Layout-Engine.html#method_add_meta_box">add_meta_box()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Returns an array describing a meta box.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/Footnotes-Layout-Engine.html#method_add_newline">add_newline()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Returns a line break to start a new line.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/Footnotes-Layout-Engine.html#method_add_num_box">add_num_box()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Returns the html tag for an input [type = num].</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/Footnotes-Layout-Engine.html#method_add_section">add_section()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Returns an array describing a sub page section.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/Footnotes-Layout-Engine.html#method_add_select_box">add_select_box()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Returns the html tag for a select box.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/Footnotes-Layout-Engine.html#method_add_text">add_text()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Returns a simple text inside html &lt;span&gt; text.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/Footnotes-Layout-Engine.html#method_add_text_box">add_text_box()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Returns the html tag for an input [type = text].</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/Footnotes-Layout-Engine.html#method_add_textarea">add_textarea()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Returns the html tag for a text area.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/Footnotes-Layout-Settings.html#method_get_meta_boxes">get_meta_boxes()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Returns an array of all registered meta boxes for each section of the sub page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/Footnotes-Layout-Settings.html#method_get_sections">get_sections()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Returns an array of all registered sections for the sub page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/Footnotes-Layout-Settings.html#method_get_sub_page_slug">get_sub_page_slug()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Returns the unique slug of the sub page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/Footnotes-Layout-Settings.html#method_get_sub_page_title">get_sub_page_title()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Returns the title of the sub page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/Footnotes-Layout-Engine.html#method_load_setting">load_setting()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Loads specific setting and returns an array with the keys [id, name, value].</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/Footnotes-Layout-Engine.html#method_append_scripts">append_scripts()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Append javascript and css files for specific sub page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/Footnotes-Layout-Engine.html#method_register_meta_boxes">register_meta_boxes()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Registers all Meta boxes for a sub page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/Footnotes-Layout-Engine.html#method_save_settings">save_settings()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Save all Plugin settings.</dd>
</dl>
<section class="phpdocumentor-properties">
<h3 class="phpdocumentor-elements__header" id="properties">
Properties
<a href="classes/Footnotes-Layout-Settings.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_a_arr_sections">
$a_arr_sections
<a href="classes/Footnotes-Layout-Engine.html#property_a_arr_sections" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<p class="phpdocumentor-summary">Stores all Sections for the child sub page.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">$a_arr_sections</span>
= <span class="phpdocumentor-signature__default-value">array()</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_a_str_sub_page_hook">
$a_str_sub_page_hook
<a href="classes/Footnotes-Layout-Engine.html#property_a_str_sub_page_hook" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">32</span>
</aside>
<p class="phpdocumentor-summary">Stores the Hook connection string for the child sub page.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">null|string</span>
<span class="phpdocumentor-signature__name">$a_str_sub_page_hook</span>
= <span class="phpdocumentor-signature__default-value">
ull</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
</article>
</section>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/Footnotes-Layout-Settings.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_amp_compat">
amp_compat()
<a href="classes/Footnotes-Layout-Settings.html#method_amp_compat" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">177</span>
</aside>
<p class="phpdocumentor-summary">Displays the AMP compatibility mode option.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">amp_compat</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.5.11</span>
<section class="phpdocumentor-description"><p>(draft)</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.6.0</span>
<section class="phpdocumentor-description"><p>(release)</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_custom_css">
custom_css()
<a href="classes/Footnotes-Layout-Settings.html#method_custom_css" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">1148</span>
</aside>
<p class="phpdocumentor-summary">Displays the Custom CSS box.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">custom_css</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"><p>Edited:</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.1.6</span>
<section class="phpdocumentor-description"><p>drop localized notices for CSS classes as the number increased to 16
list directly in the template, as CSS is in English anyway</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.2.2</span>
<section class="phpdocumentor-description"><p>migrate Custom CSS to a dedicated tab</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.3.0</span>
<section class="phpdocumentor-description"><p>say 'copy-paste' instead of 'cut and paste' since cutting is not needed</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.5.1</span>
<section class="phpdocumentor-description"><p>mention validity while visible, thanks to @rkupadhya bug report</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
2021-04-26 22:06:10 +00:00
<section class="phpdocumentor-description"><p>admin/partials/customize-css.html</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_custom_css_migration">
custom_css_migration()
<a href="classes/Footnotes-Layout-Settings.html#method_custom_css_migration" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">1187</span>
</aside>
<p class="phpdocumentor-summary">Displays transitional legacy Custom CSS box.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">custom_css_migration</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.2.2</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_custom_css_new">
custom_css_new()
<a href="classes/Footnotes-Layout-Settings.html#method_custom_css_new" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">1223</span>
</aside>
<p class="phpdocumentor-summary">Displays the new Custom CSS box.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">custom_css_new</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.2.2</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_description">
description()
<a href="classes/Footnotes-Layout-Engine.html#method_description" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">305</span>
</aside>
<p class="phpdocumentor-summary">Output the Description of a section. May be overwritten in any section.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">description</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_display_content">
display_content()
<a href="classes/Footnotes-Layout-Engine.html#method_display_content" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">205</span>
</aside>
<p class="phpdocumentor-summary">Displays the content of specific sub page.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">display_content</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_donate">
donate()
<a href="classes/Footnotes-Layout-Settings.html#method_donate" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">1388</span>
</aside>
<p class="phpdocumentor-summary">Displays all Donate button to support the developers.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">donate</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_excerpts">
excerpts()
<a href="classes/Footnotes-Layout-Settings.html#method_excerpts" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">679</span>
</aside>
<p class="phpdocumentor-summary">Displays the footnotes in excerpt setting.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">excerpts</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"><p>Edited heading</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.1.1</span>
<section class="phpdocumentor-description"><p>more settings and notices, thanks to @nikelaos</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.2.0</span>
<section class="phpdocumentor-description"><p>dedicated to the excerpt setting and its notices</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://wordpress.org/support/topic/doesnt-work-any-more-11/#post-13687068"> https://wordpress.org/support/topic/doesnt-work-any-more-11/#post-13687068 </a>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://wordpress.org/support/topic/jquery-comes-up-in-feed-content/#post-13110879"> https://wordpress.org/support/topic/jquery-comes-up-in-feed-content/#post-13110879 </a>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_get_priority">
get_priority()
<a href="classes/Footnotes-Layout-Settings.html#method_get_priority" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">59</span>
</aside>
<p class="phpdocumentor-summary">Returns a Priority index. Lower numbers have a higher Priority.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">get_priority</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_hard_links">
hard_links()
<a href="classes/Footnotes-Layout-Settings.html#method_hard_links" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">571</span>
</aside>
<p class="phpdocumentor-summary">Displays all options for the fragment identifier configuration.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">hard_links</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.2.0</span>
<section class="phpdocumentor-description"><p>in scrolling().</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.5.12</span>
<section class="phpdocumentor-description"><p>separate metabox.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_Help">
Help()
<a href="classes/Footnotes-Layout-Settings.html#method_Help" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">1318</span>
</aside>
<p class="phpdocumentor-summary">Displays a short introduction to the Plugin.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">Help</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"></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.7.0</span>
<section class="phpdocumentor-description"><p>Sanitize Lorem Ipsum filler text.</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://blog.prototypr.io/why-testing-with-real-content-is-better-than-lorem-ipsum-c7c79586ee72"> https://blog.prototypr.io/why-testing-with-real-content-is-better-than-lorem-ipsum-c7c79586ee72 </a>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_hyperlink_arrow">
hyperlink_arrow()
<a href="classes/Footnotes-Layout-Settings.html#method_hyperlink_arrow" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">1115</span>
</aside>
<p class="phpdocumentor-summary">Displays all settings for the backlink symbol.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">hyperlink_arrow</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"><ul>
<li>Update: <strong>symbol for backlinks</strong> removed; hyperlink moved to the reference number.</li>
</ul>
</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.0.0</span>
<section class="phpdocumentor-description"><p>The former 'hyperlink arrow' is incompatible with combined identical footnotes.</p>
<ul>
<li>Update: Reference container: clarify backlink semantics by prepended transitional up arrow, thanks to @mmallett issue report.</li>
</ul>
</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.0.3</span>
<section class="phpdocumentor-description"><ul>
<li>Update: Restore arrow settings to customize or disable the now prepended arrow symbol, thanks to @mmallett issue report.</li>
</ul>
</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.0.4</span>
<section class="phpdocumentor-description"></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.1.4</span>
<section class="phpdocumentor-description"><p>moved to Settings &gt; Reference container &gt; Display a backlink symbol</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.2.1</span>
<section class="phpdocumentor-description"><p>and 2.2.4 back here</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">reporter</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>@mmallett</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://wordpress.org/support/topic/mouse-over-broken/#post-13593037"> https://wordpress.org/support/topic/mouse-over-broken/#post-13593037 </a>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_label_solution">
label_solution()
<a href="classes/Footnotes-Layout-Settings.html#method_label_solution" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">760</span>
</aside>
<p class="phpdocumentor-summary">Displays the setting for the input label issue solution.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">label_solution</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.5.12</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_lookup_hooks">
lookup_hooks()
<a href="classes/Footnotes-Layout-Settings.html#method_lookup_hooks" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">1259</span>
</aside>
<p class="phpdocumentor-summary">Displays available Hooks to look for Footnote short codes.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">lookup_hooks</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.5</span>
<section class="phpdocumentor-description"><p>Edited:</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.1.1</span>
<section class="phpdocumentor-description"><p>priority level setting for the_content</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.1.4</span>
<section class="phpdocumentor-description"><p>priority level settings for the other hooks</p>
<p>priority level was initially hard-coded default
shows &quot;9223372036854775807&quot; in the numbox
empty should be interpreted as PHP_INT_MAX,
but a numbox cannot be set to empty: <a href="https://github.com/Modernizr/Modernizr/issues/171">https://github.com/Modernizr/Modernizr/issues/171</a>
define -1 as PHP_INT_MAX instead</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.2.9</span>
<section class="phpdocumentor-description"><p>removed the warning about the widget text hook</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.2.9</span>
<section class="phpdocumentor-description"><p>added guidance for the widget text hook</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_love">
love()
<a href="classes/Footnotes-Layout-Settings.html#method_love" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">627</span>
</aside>
<p class="phpdocumentor-summary">Displays all settings for &#039;I love Footnotes&#039;.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">love</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"><p>Edited:</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.2.0</span>
<section class="phpdocumentor-description"><p>position-sensitive placeholders to support more locales</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.2.0</span>
<section class="phpdocumentor-description"><p>more options</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_mouseover_box">
mouseover_box()
<a href="classes/Footnotes-Layout-Settings.html#method_mouseover_box" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">793</span>
</aside>
<p class="phpdocumentor-summary">Displays enabled status for the footnotes mouse-over box.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">mouseover_box</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.2</span>
<section class="phpdocumentor-description"><p>Edited:</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.2.0</span>
<section class="phpdocumentor-description"><p>5 parts to address increased settings number</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.2.5</span>
<section class="phpdocumentor-description"><p>position settings for alternative tooltips</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_mouseover_box_appearance">
mouseover_box_appearance()
<a href="classes/Footnotes-Layout-Settings.html#method_mouseover_box_appearance" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">1026</span>
</aside>
<p class="phpdocumentor-summary">Displays style settings for the footnotes mouse-over box.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">mouseover_box_appearance</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.2.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_mouseover_box_dimensions">
mouseover_box_dimensions()
<a href="classes/Footnotes-Layout-Settings.html#method_mouseover_box_dimensions" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">884</span>
</aside>
<p class="phpdocumentor-summary">Displays dimensions setting for the footnotes mouse-over box.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">mouseover_box_dimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.2.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_mouseover_box_position">
mouseover_box_position()
<a href="classes/Footnotes-Layout-Settings.html#method_mouseover_box_position" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">829</span>
</aside>
<p class="phpdocumentor-summary">Displays position settings for the footnotes mouse-over box.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">mouseover_box_position</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.2.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_mouseover_box_text">
mouseover_box_text()
<a href="classes/Footnotes-Layout-Settings.html#method_mouseover_box_text" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">984</span>
</aside>
<p class="phpdocumentor-summary">Displays dedicated tooltip text settings for the footnotes mouse-over box.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">mouseover_box_text</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.2.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_mouseover_box_timing">
mouseover_box_timing()
<a href="classes/Footnotes-Layout-Settings.html#method_mouseover_box_timing" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">910</span>
</aside>
<p class="phpdocumentor-summary">Displays timing settings for the footnotes mouse-over box.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">mouseover_box_timing</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.2.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_mouseover_box_truncation">
mouseover_box_truncation()
<a href="classes/Footnotes-Layout-Settings.html#method_mouseover_box_truncation" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">947</span>
</aside>
<p class="phpdocumentor-summary">Displays truncation settings for the footnotes mouse-over box.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">mouseover_box_truncation</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.2.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_numbering">
numbering()
<a href="classes/Footnotes-Layout-Settings.html#method_numbering" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">469</span>
</aside>
<p class="phpdocumentor-summary">Displays all options for the footnotes numbering.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">numbering</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.2.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_reference_container">
reference_container()
<a href="classes/Footnotes-Layout-Settings.html#method_reference_container" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">209</span>
</aside>
<p class="phpdocumentor-summary">Displays all settings for the reference container.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">reference_container</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"><p>Completed:</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.1.4:</span>
<section class="phpdocumentor-description"><p>layout and typography options</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.2.5</span>
<section class="phpdocumentor-description"><p>options for label element and label bottom border, thanks to @markhillyer</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://wordpress.org/support/topic/how-do-i-eliminate-the-horizontal-line-beneath-the-reference-container-heading/"> https://wordpress.org/support/topic/how-do-i-eliminate-the-horizontal-line-beneath-the-reference-container-heading/ </a>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_register_sections">
register_sections()
<a href="classes/Footnotes-Layout-Engine.html#method_register_sections" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">151</span>
</aside>
<p class="phpdocumentor-summary">Registers all sections for a sub page.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">register_sections</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_register_sub_page">
register_sub_page()
<a href="classes/Footnotes-Layout-Engine.html#method_register_sub_page" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">125</span>
</aside>
<p class="phpdocumentor-summary">Registers a sub page.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">register_sub_page</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_scrolling">
scrolling()
<a href="classes/Footnotes-Layout-Settings.html#method_scrolling" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">514</span>
</aside>
<p class="phpdocumentor-summary">Displays all options for the scrolling behavior.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">scrolling</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.2.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_start_end">
start_end()
<a href="classes/Footnotes-Layout-Settings.html#method_start_end" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">392</span>
</aside>
<p class="phpdocumentor-summary">Displays all options for the footnotes start and end tag short codes.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">start_end</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"><p>Edited heading</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.2.0</span>
<section class="phpdocumentor-description"><p>start/end short codes: more predefined options</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.2.0</span>
<section class="phpdocumentor-description"><p>3 boxes for clarity</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.2.5</span>
<section class="phpdocumentor-description"><p>support for Ibid. notation thanks to @meglio</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.4.0</span>
<section class="phpdocumentor-description"><p>added warning about Block Editor escapement disruption</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.4.0</span>
<section class="phpdocumentor-description"><p>removed the HTML comment tag option</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.5.0</span>
<section class="phpdocumentor-description"><p>Shortcode syntax validation: add more information around the setting, thanks to @andreasra</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://wordpress.org/support/topic/doesnt-work-with-mailpoet/"> https://wordpress.org/support/topic/doesnt-work-with-mailpoet/ </a>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://wordpress.org/support/topic/add-support-for-ibid-notation/"> https://wordpress.org/support/topic/add-support-for-ibid-notation/ </a>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://wordpress.org/support/topic/warning-unbalanced-footnote-start-tag-short-code-before/"> https://wordpress.org/support/topic/warning-unbalanced-footnote-start-tag-short-code-before/ </a>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_superscript">
superscript()
<a href="classes/Footnotes-Layout-Settings.html#method_superscript" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">715</span>
</aside>
<p class="phpdocumentor-summary">Displays all settings for the footnote referrers.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">superscript</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"><p>Edited heading</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.1.1</span>
<section class="phpdocumentor-description"><p>option for superscript (optionally baseline referrers)</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.2.0</span>
<section class="phpdocumentor-description"><p>option for link element moved here</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_add_checkbox">
add_checkbox()
<a href="classes/Footnotes-Layout-Engine.html#method_add_checkbox" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">433</span>
</aside>
<p class="phpdocumentor-summary">Returns the html tag for an input [type = checkbox].</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">add_checkbox</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_setting_name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_setting_name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Name of the Settings key to pre load the input field.</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">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_add_color_selection">
add_color_selection()
<a href="classes/Footnotes-Layout-Engine.html#method_add_color_selection" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">511</span>
</aside>
<p class="phpdocumentor-summary">Returns the html tag for an input [type = text] with color selection class.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">add_color_selection</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_setting_name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_setting_name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Name of the Settings key to pre load the input field.</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">1.5.6</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_add_label">
add_label()
<a href="classes/Footnotes-Layout-Engine.html#method_add_label" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">380</span>
</aside>
<p class="phpdocumentor-summary">Returns the html tag for an input/select label.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">add_label</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_setting_name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_caption</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_setting_name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Name of the Settings key to connect the Label with the input/select field.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_caption</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Label caption.</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">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_add_line_space">
add_line_space()
<a href="classes/Footnotes-Layout-Engine.html#method_add_line_space" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">357</span>
</aside>
<p class="phpdocumentor-summary">Returns a line break to have a space between two lines.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">add_line_space</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_add_meta_box">
add_meta_box()
<a href="classes/Footnotes-Layout-Engine.html#method_add_meta_box" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">111</span>
</aside>
<p class="phpdocumentor-summary">Returns an array describing a meta box.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">add_meta_box</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_section_id</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_id</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_title</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_callback_function_name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_section_id</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Parent Section ID.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_id</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Unique ID suffix.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_title</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Title for the meta box.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_callback_function_name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Class method name for callback.</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">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
&mdash;
<section class="phpdocumentor-description"><p>meta box description to be able to append a meta box to the output.</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_add_newline">
add_newline()
<a href="classes/Footnotes-Layout-Engine.html#method_add_newline" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">347</span>
</aside>
<p class="phpdocumentor-summary">Returns a line break to start a new line.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">add_newline</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_add_num_box">
add_num_box()
<a href="classes/Footnotes-Layout-Engine.html#method_add_num_box" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">535</span>
</aside>
<p class="phpdocumentor-summary">Returns the html tag for an input [type = num].</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">add_num_box</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_setting_name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_in_min</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_int_max</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_bool_deci</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_setting_name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Name of the Settings key to pre load the input field.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_in_min</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Minimum value.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_int_max</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Maximum value.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_bool_deci</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">false</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>true if 0.1 steps and floating to string, false if integer (default).</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">1.5.0</span>
<section class="phpdocumentor-description"></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.1.4</span>
<section class="phpdocumentor-description"><p>step argument and number_format() to allow decimals ..</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"><p>Edited:</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_add_section">
add_section()
<a href="classes/Footnotes-Layout-Engine.html#method_add_section" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">92</span>
</aside>
<p class="phpdocumentor-summary">Returns an array describing a sub page section.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">add_section</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_id</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_title</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_int_settings_container_index</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_bool_has_submit_button</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">true</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_id</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Unique ID suffix.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_title</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Title of the section.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_int_settings_container_index</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Settings Container Index.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_bool_has_submit_button</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">true</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Should a Submit Button be displayed for this section, default: true.</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">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
&mdash;
<section class="phpdocumentor-description"><p>Array describing the section.</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_add_select_box">
add_select_box()
<a href="classes/Footnotes-Layout-Engine.html#method_add_select_box" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">461</span>
</aside>
<p class="phpdocumentor-summary">Returns the html tag for a select box.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">add_select_box</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_setting_name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_arr_options</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_setting_name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Name of the Settings key to pre select the current value.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_arr_options</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Possible options to be selected.</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">1.5.0</span>
<section class="phpdocumentor-description"><ul>
<li>Bugfix: Dashboard: Referrers and tooltips: Backlink symbol: debug select box by reverting identity check to equality check, thanks to @lolzim bug report.</li>
</ul>
</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.5.13</span>
<section class="phpdocumentor-description"></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.5.15</span>
<section class="phpdocumentor-description"><p>Bugfix: Dashboard: General settings: Footnote start and end short codes: debug select box for shortcodes with pointy brackets.</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.6.1</span>
<section class="phpdocumentor-description"><p>Restore esc_attr() in load_setting(), remove htmlspecialchars() here.</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">reporter</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>@lolzim</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_add_text">
add_text()
<a href="classes/Footnotes-Layout-Engine.html#method_add_text" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">368</span>
</aside>
<p class="phpdocumentor-summary">Returns a simple text inside html &lt;span&gt; text.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">add_text</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_text</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_text</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Message to be surrounded with simple html tag (span).</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">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_add_text_box">
add_text_box()
<a href="classes/Footnotes-Layout-Engine.html#method_add_text_box" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">408</span>
</aside>
<p class="phpdocumentor-summary">Returns the html tag for an input [type = text].</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">add_text_box</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_setting_name</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_max_length</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">999</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_bool_readonly</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_bool_hidden</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_setting_name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Name of the Settings key to pre load the input field.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_max_length</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">999</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Maximum length of the input, default 999 characters.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_bool_readonly</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">false</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Set the input to be read only, default false.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_bool_hidden</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">false</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Set the input to be hidden, default false.</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">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_add_textarea">
add_textarea()
<a href="classes/Footnotes-Layout-Engine.html#method_add_textarea" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">493</span>
</aside>
<p class="phpdocumentor-summary">Returns the html tag for a text area.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">add_textarea</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_setting_name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_setting_name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Name of the Settings key to pre fill the text area.</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">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_get_meta_boxes">
get_meta_boxes()
<a href="classes/Footnotes-Layout-Settings.html#method_get_meta_boxes" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">132</span>
</aside>
<p class="phpdocumentor-summary">Returns an array of all registered meta boxes for each section of the sub page.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">get_meta_boxes</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"></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.0.0</span>
<section class="phpdocumentor-description"><p>discontinued</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.0.4</span>
<section class="phpdocumentor-description"><p>restored to meet user demand for arrow symbol semantics</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.1.4</span>
<section class="phpdocumentor-description"><p>discontinued, content moved to Settings &gt; Reference container &gt; Display a backlink symbol</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.0.4</span>
<section class="phpdocumentor-description"><p>to reflect changes in meta box label display since WPv5.5
spans need position:fixed and become unlocalizable
fix: logo is kept only in the label that doesn't need to be translated:
Change string &quot;%s styling&quot; to &quot;Footnotes styling&quot; to fix layout in WPv5.5</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.1.6</span>
<section class="phpdocumentor-description"><p>/ 2.2.0 tabs reordered and renamed</p>
</section>
</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="\details">details</abbr></span>
<section class="phpdocumentor-description"><p>in class/config.php</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
&mdash;
<section class="phpdocumentor-description"><p>Edited for 2.0.0 and later.</p>
<p>hyperlink_arrow meta box:</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_get_sections">
get_sections()
<a href="classes/Footnotes-Layout-Settings.html#method_get_sections" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">95</span>
</aside>
<p class="phpdocumentor-summary">Returns an array of all registered sections for the sub page.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">get_sections</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"></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.1.6</span>
<section class="phpdocumentor-description"><p>tabs reordered and renamed</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.1.6</span>
<section class="phpdocumentor-description"><p>removed if statement around expert tab</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://www.linkedin.com/pulse/20140610191154-4746170-configuration-vs-customization-when-and-why-would-i-implement-each"> https://www.linkedin.com/pulse/20140610191154-4746170-configuration-vs-customization-when-and-why-would-i-implement-each </a>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
&mdash;
<section class="phpdocumentor-description"><p>Edited:</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_get_sub_page_slug">
get_sub_page_slug()
<a href="classes/Footnotes-Layout-Settings.html#method_get_sub_page_slug" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">69</span>
</aside>
<p class="phpdocumentor-summary">Returns the unique slug of the sub page.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">get_sub_page_slug</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-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>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_get_sub_page_title">
get_sub_page_title()
<a href="classes/Footnotes-Layout-Settings.html#method_get_sub_page_title" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-settings.php"><a href="files/src-admin-layout-class-footnotes-layout-settings.html"><abbr title="src/admin/layout/class-footnotes-layout-settings.php">class-footnotes-layout-settings.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">79</span>
</aside>
<p class="phpdocumentor-summary">Returns the title of the sub page.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">get_sub_page_title</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_load_setting">
load_setting()
<a href="classes/Footnotes-Layout-Engine.html#method_load_setting" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">331</span>
</aside>
<p class="phpdocumentor-summary">Loads specific setting and returns an array with the keys [id, name, value].</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">load_setting</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_setting_key_name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_setting_key_name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Settings Array key name.</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">1.5.0</span>
<section class="phpdocumentor-description"></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.5.11</span>
<section class="phpdocumentor-description"><p>Remove escapement function.
When refactoring the codebase after 2.5.8, all and every output was escaped.
After noticing that the plugin was broken, all escapement functions were removed.</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.5.15</span>
<section class="phpdocumentor-description"><p>To fix it, the data was escaped in add_select_box() instead.</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.6.1</span>
<section class="phpdocumentor-description"><p>Restore esc_attr() in load_setting().</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://github.com/markcheret/footnotes/pull/50/commits/25c3f2f12eb5de1079e9215bf624ec4289b095a5"> https://github.com/markcheret/footnotes/pull/50/commits/25c3f2f12eb5de1079e9215bf624ec4289b095a5 </a>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://github.com/markcheret/footnotes/pull/50#issuecomment-787624123"> <p>In that process, this instance of esc_attr() was removed too, so the plugin was
broken again.</p>
</a>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://github.com/markcheret/footnotes/pull/50/commits/25c3f2f12eb5de1079e9215bf624ec4289b095a5#diff-a8ed6e859c32a18fc10bbbad3b4dd8ce7f43f2378d29471c7638e314ab30f1bdL349-L354"> https://github.com/markcheret/footnotes/pull/50/commits/25c3f2f12eb5de1079e9215bf624ec4289b095a5#diff-a8ed6e859c32a18fc10bbbad3b4dd8ce7f43f2378d29471c7638e314ab30f1bdL349-L354 </a>
</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="\add_select_box()">add_select_box()</abbr></span>
<section class="phpdocumentor-description"><p>This is the only instance of esc_|kses|sanitize in the pre-2.5.11 codebase.
Removing this did not fix the quotation mark backslash escapement bug.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
&mdash;
<section class="phpdocumentor-description"><p>Contains Settings ID, Settings Name and Settings Value.</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_append_scripts">
append_scripts()
<a href="classes/Footnotes-Layout-Engine.html#method_append_scripts" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">192</span>
</aside>
<p class="phpdocumentor-summary">Append javascript and css files for specific sub page.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">append_scripts</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_register_meta_boxes">
register_meta_boxes()
<a href="classes/Footnotes-Layout-Engine.html#method_register_meta_boxes" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">171</span>
</aside>
<p class="phpdocumentor-summary">Registers all Meta boxes for a sub page.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">register_meta_boxes</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$p_str_parent_id</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$p_str_parent_id</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Parent section unique id.</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">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_save_settings">
save_settings()
<a href="classes/Footnotes-Layout-Engine.html#method_save_settings" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
2021-04-26 22:06:10 +00:00
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
2021-04-26 22:06:10 +00:00
<span class="phpdocumentor-element-found-in__line">277</span>
</aside>
<p class="phpdocumentor-summary">Save all Plugin settings.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">save_settings</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</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">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
</section>
</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-Layout-Settings.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
</body>
</html>