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-admin-layout-Settings.html

3743 lines
184 KiB
HTML
Raw Normal View History

2021-05-01 20:39:33 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Documentation</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link 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>
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h4>
<ul class="phpdocumentor-list">
<li><a href="namespaces/footnotes-admin.html"><abbr title="\footnotes\admin">admin</abbr></a></li>
<li><a href="namespaces/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
<li><a href="namespaces/footnotes-general.html"><abbr title="\footnotes\general">general</abbr></a></li>
</ul>
</section>
2021-05-02 20:27:53 +00:00
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
2021-05-01 20:39:33 +00:00
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="namespaces/footnotes.html">footnotes</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/footnotes-admin.html">admin</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/footnotes-admin-layout.html">layout</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
Settings
<span class="phpdocumentor-element__extends">
extends <a href="classes/footnotes-admin-layout-Engine.html"><abbr title="\footnotes\admin\layout\Engine">Engine</abbr></a>
</span>
2021-05-02 20:27:53 +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>
2021-05-01 20:39:33 +00:00
</h2>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">36</span>
2021-05-01 20:39:33 +00:00
</aside>
<p class="phpdocumentor-summary">Class to initialise all defined page layouts.</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>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/footnotes-admin-layout-Engine.html"><abbr title="\footnotes\admin\layout\Engine">Engine</abbr></a></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">
2021-05-02 20:27:53 +00:00
<a href="classes/footnotes-admin-layout-Engine.html#property_plugin_name">$plugin_name</a>
2021-05-01 20:39:33 +00:00
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: string </span>
2021-05-01 20:39:33 +00:00
</dt>
2021-05-02 20:27:53 +00:00
<dd>The ID of this plugin.</dd>
2021-05-01 20:39:33 +00:00
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
2021-05-02 20:27:53 +00:00
<a href="classes/footnotes-admin-layout-Engine.html#property_sections">$sections</a>
2021-05-01 20:39:33 +00:00
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: array&lt;string|int, mixed&gt; </span>
2021-05-01 20:39:33 +00:00
</dt>
2021-05-02 20:27:53 +00:00
<dd>Stores all Sections for the child sub-page.</dd>
2021-05-01 20:39:33 +00:00
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
2021-05-02 20:27:53 +00:00
<a href="classes/footnotes-admin-layout-Engine.html#property_sub_page_hook">$sub_page_hook</a>
2021-05-01 20:39:33 +00:00
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: string|null </span>
2021-05-01 20:39:33 +00:00
</dt>
2021-05-02 20:27:53 +00:00
<dd>Stores the Hook connection string for the child sub-page.</dd>
2021-05-01 20:39:33 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-layout-Settings.html#method___construct">__construct()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Initialize the class and set its properties.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-layout-Settings.html#method_amp_compat">amp_compat()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</dt>
<dd>Displays the AMP compatibility mode option.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-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-admin-layout-Settings.html#method_custom_css_migration">custom_css_migration()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</dt>
<dd>Displays transitional legacy Custom CSS box.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-layout-Settings.html#method_custom_css_new">custom_css_new()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</dt>
<dd>Displays the new Custom CSS box.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-layout-Engine.html#method_description">description()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</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-admin-layout-Engine.html#method_display_content">display_content()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</dt>
<dd>Displays the content of specific sub-page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-layout-Settings.html#method_donate">donate()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</dt>
<dd>Displays all Donate button to support the developers.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-layout-Settings.html#method_excerpts">excerpts()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</dt>
<dd>Displays the footnotes in excerpt setting.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-layout-Settings.html#method_get_priority">get_priority()</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Returns a priority index.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-layout-Settings.html#method_hard_links">hard_links()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</dt>
<dd>Displays all options for the fragment identifier configuration.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
2021-05-02 20:27:53 +00:00
<a href="classes/footnotes-admin-layout-Settings.html#method_help">help()</a>
2021-05-01 20:39:33 +00:00
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</dt>
<dd>Displays a short introduction to the plugin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-layout-Settings.html#method_hyperlink_arrow">hyperlink_arrow()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</dt>
<dd>Displays all settings for the backlink symbol.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-layout-Settings.html#method_label_solution">label_solution()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</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-admin-layout-Settings.html#method_lookup_hooks">lookup_hooks()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</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-admin-layout-Settings.html#method_love">love()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</dt>
<dd>Displays all settings for I love Footnotes note.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-layout-Settings.html#method_mouseover_box">mouseover_box()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</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-admin-layout-Settings.html#method_mouseover_box_appearance">mouseover_box_appearance()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</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-admin-layout-Settings.html#method_mouseover_box_dimensions">mouseover_box_dimensions()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</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-admin-layout-Settings.html#method_mouseover_box_position">mouseover_box_position()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</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-admin-layout-Settings.html#method_mouseover_box_text">mouseover_box_text()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</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-admin-layout-Settings.html#method_mouseover_box_timing">mouseover_box_timing()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</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-admin-layout-Settings.html#method_mouseover_box_truncation">mouseover_box_truncation()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</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-admin-layout-Settings.html#method_numbering">numbering()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</dt>
<dd>Displays all options for the footnotes numbering.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-layout-Settings.html#method_reference_container">reference_container()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</dt>
<dd>Displays all settings for the reference container.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-layout-Engine.html#method_register_sections">register_sections()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</dt>
<dd>Registers all sections for a sub-page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-layout-Engine.html#method_register_sub_page">register_sub_page()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</dt>
<dd>Registers a sub-page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-layout-Settings.html#method_scrolling">scrolling()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</dt>
<dd>Displays all options for the scrolling behavior.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-layout-Settings.html#method_start_end">start_end()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</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-admin-layout-Settings.html#method_superscript">superscript()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</dt>
<dd>Displays all settings for the footnote referrers.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/footnotes-admin-layout-Engine.html#method_add_checkbox">add_checkbox()</a>
<span>
&nbsp;: string </span>
</dt>
2021-05-02 20:27:53 +00:00
<dd>Constructs the HTML for a checkbox &#039;input&#039; element.</dd>
2021-05-01 20:39:33 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/footnotes-admin-layout-Engine.html#method_add_color_selection">add_color_selection()</a>
<span>
&nbsp;: string </span>
</dt>
2021-05-02 20:27:53 +00:00
<dd>Constructs the HTML for a text &#039;input&#039; element with the colour selection
2021-05-01 20:39:33 +00:00
class.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/footnotes-admin-layout-Engine.html#method_add_label">add_label()</a>
<span>
&nbsp;: string </span>
</dt>
2021-05-02 20:27:53 +00:00
<dd>Returns the HTML tag for a &#039;label&#039; element.</dd>
2021-05-01 20:39:33 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/footnotes-admin-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-admin-layout-Engine.html#method_add_num_box">add_num_box()</a>
<span>
&nbsp;: string </span>
</dt>
2021-05-02 20:27:53 +00:00
<dd>Constructs the HTML for numeric &#039;input&#039; element.</dd>
2021-05-01 20:39:33 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/footnotes-admin-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-admin-layout-Engine.html#method_add_select_box">add_select_box()</a>
<span>
&nbsp;: string </span>
</dt>
2021-05-02 20:27:53 +00:00
<dd>Constructs the HTML for a &#039;select&#039; element.</dd>
2021-05-01 20:39:33 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/footnotes-admin-layout-Engine.html#method_add_text">add_text()</a>
<span>
&nbsp;: string </span>
</dt>
2021-05-02 20:27:53 +00:00
<dd>Returns a simple text inside a &#039;span&#039; element.</dd>
2021-05-01 20:39:33 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/footnotes-admin-layout-Engine.html#method_add_text_box">add_text_box()</a>
<span>
&nbsp;: string </span>
</dt>
2021-05-02 20:27:53 +00:00
<dd>Constructs the HTML for a text &#039;input&#039; element.</dd>
2021-05-01 20:39:33 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/footnotes-admin-layout-Engine.html#method_add_textarea">add_textarea()</a>
<span>
&nbsp;: string </span>
</dt>
2021-05-02 20:27:53 +00:00
<dd>Constructs the HTML for a &#039;textarea&#039; element.</dd>
2021-05-01 20:39:33 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/footnotes-admin-layout-Settings.html#method_get_meta_boxes">get_meta_boxes()</a>
<span>
&nbsp;: array&lt;string|int, array&lt;string|int, mixed&gt;&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-admin-layout-Settings.html#method_get_sections">get_sections()</a>
<span>
&nbsp;: array&lt;string|int, array&lt;string|int, mixed&gt;&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-admin-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-admin-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-admin-layout-Engine.html#method_load_setting">load_setting()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Loads a specified setting.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/footnotes-admin-layout-Engine.html#method_append_scripts">append_scripts()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</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-admin-layout-Engine.html#method_register_meta_boxes">register_meta_boxes()</a>
<span>
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</dt>
<dd>Registers all Meta boxes for a sub-page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/footnotes-admin-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-admin-layout-Settings.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="
phpdocumentor-element
-property
-protected
"
>
2021-05-02 20:27:53 +00:00
<h4 class="phpdocumentor-element__name" id="property_plugin_name">
$plugin_name
<a href="classes/footnotes-admin-layout-Engine.html#property_plugin_name" class="headerlink"><i class="fas fa-link"></i></a>
2021-05-01 20:39:33 +00:00
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-engine.php"><a href="files/src-admin-layout-class-engine.html"><abbr title="src/admin/layout/class-engine.php">class-engine.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">42</span>
2021-05-01 20:39:33 +00:00
</aside>
2021-05-02 20:27:53 +00:00
<p class="phpdocumentor-summary">The ID of this plugin.</p>
2021-05-01 20:39:33 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$plugin_name</span>
</code>
2021-05-01 20:39:33 +00:00
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>protected</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-tag-link">2.8.0</span>
2021-05-01 20:39:33 +00:00
<section class="phpdocumentor-description"></section>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
2021-05-02 20:27:53 +00:00
<h4 class="phpdocumentor-element__name" id="property_sections">
$sections
<a href="classes/footnotes-admin-layout-Engine.html#property_sections" class="headerlink"><i class="fas fa-link"></i></a>
2021-05-01 20:39:33 +00:00
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-engine.php"><a href="files/src-admin-layout-class-engine.html"><abbr title="src/admin/layout/class-engine.php">class-engine.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">62</span>
2021-05-01 20:39:33 +00:00
</aside>
2021-05-02 20:27:53 +00:00
<p class="phpdocumentor-summary">Stores all Sections for the child sub-page.</p>
2021-05-01 20:39:33 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">$sections</span>
= <span class="phpdocumentor-signature__default-value">array()</span></code>
2021-05-01 20:39:33 +00:00
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>protected</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">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
2021-05-02 20:27:53 +00:00
<h4 class="phpdocumentor-element__name" id="property_sub_page_hook">
$sub_page_hook
<a href="classes/footnotes-admin-layout-Engine.html#property_sub_page_hook" class="headerlink"><i class="fas fa-link"></i></a>
2021-05-01 20:39:33 +00:00
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-engine.php"><a href="files/src-admin-layout-class-engine.html"><abbr title="src/admin/layout/class-engine.php">class-engine.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">52</span>
2021-05-01 20:39:33 +00:00
</aside>
2021-05-02 20:27:53 +00:00
<p class="phpdocumentor-summary">Stores the Hook connection string for the child sub-page.</p>
2021-05-01 20:39:33 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__type">string|null</span>
<span class="phpdocumentor-signature__name">$sub_page_hook</span>
= <span class="phpdocumentor-signature__default-value">null</span></code>
2021-05-01 20:39:33 +00:00
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>protected</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-tag-link">1.5.0</span>
2021-05-01 20:39:33 +00:00
<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-admin-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___construct">
__construct()
<a href="classes/footnotes-admin-layout-Settings.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">44</span>
2021-05-01 20:39:33 +00:00
</aside>
<p class="phpdocumentor-summary">Initialize the class and set its properties.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$plugin_name</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">$plugin_name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The name of this plugin.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
<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_amp_compat">
amp_compat()
<a href="classes/footnotes-admin-layout-Settings.html#method_amp_compat" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">65</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">amp_compat</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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.6.0</span>
<section class="phpdocumentor-description"><p>(release)</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Settings.html#method_custom_css" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">976</span>
2021-05-01 20:39:33 +00:00
</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"></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
-deprecated "
>
<h4 class="phpdocumentor-element__name" id="method_custom_css_migration">
custom_css_migration()
<a href="classes/footnotes-admin-layout-Settings.html#method_custom_css_migration" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">1016</span>
2021-05-01 20:39:33 +00:00
</aside>
<p class="phpdocumentor-summary">Displays transitional legacy Custom CSS box.</p>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility">public</span>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">custom_css_migration</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">deprecated</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Settings.html#method_custom_css_new" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">1052</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">custom_css_new</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Engine.html#method_description" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-engine.php"><a href="files/src-admin-layout-class-engine.html"><abbr title="src/admin/layout/class-engine.php">class-engine.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">184</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">description</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Required? Should be <code class="prettyprint">abstract</code>?</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Engine.html#method_display_content" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-engine.php"><a href="files/src-admin-layout-class-engine.html"><abbr title="src/admin/layout/class-engine.php">class-engine.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">122</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">display_content</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Review nonce verification.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Settings.html#method_donate" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">1204</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">donate</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Settings.html#method_excerpts" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">543</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">excerpts</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Settings.html#method_get_priority" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">56</span>
2021-05-01 20:39:33 +00:00
</aside>
<p class="phpdocumentor-summary">Returns a priority index.</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"><p>Lower numbers have a higher priority.</p>
</section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">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-admin-layout-Settings.html#method_hard_links" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">445</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">hard_links</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
2021-05-02 20:27:53 +00:00
<h4 class="phpdocumentor-element__name" id="method_help">
help()
<a href="classes/footnotes-admin-layout-Settings.html#method_help" class="headerlink"><i class="fas fa-link"></i></a>
2021-05-01 20:39:33 +00:00
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">1139</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">help</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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>
2021-05-02 20:27:53 +00:00
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Review in light of admin/public split.</p>
</section>
2021-05-01 20:39:33 +00:00
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Settings.html#method_hyperlink_arrow" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">952</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">hyperlink_arrow</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Settings.html#method_label_solution" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">620</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">label_solution</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Settings.html#method_lookup_hooks" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">1082</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">lookup_hooks</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<section class="phpdocumentor-description"><p>Priority level was initially a hard-coded default
shows 9223372036854775807 in the numbox
empty should be interpreted as <code class="prettyprint">PHP_INT_MAX</code>,
but a numbox cannot be set to empty, see <a href="https://github.com/Modernizr/Modernizr/issues/171">here</a>
define -1 as <code class="prettyprint">PHP_INT_MAX</code> instead</p>
</section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.5</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Settings.html#method_love" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">497</span>
2021-05-01 20:39:33 +00:00
</aside>
<p class="phpdocumentor-summary">Displays all settings for I love Footnotes note.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">love</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Settings.html#method_mouseover_box" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">649</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">mouseover_box</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Settings.html#method_mouseover_box_appearance" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">882</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">mouseover_box_appearance</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Settings.html#method_mouseover_box_dimensions" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">740</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">mouseover_box_dimensions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Settings.html#method_mouseover_box_position" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">685</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">mouseover_box_position</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Settings.html#method_mouseover_box_text" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">840</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">mouseover_box_text</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Settings.html#method_mouseover_box_timing" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">766</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">mouseover_box_timing</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Settings.html#method_mouseover_box_truncation" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">803</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">mouseover_box_truncation</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Settings.html#method_numbering" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">344</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">numbering</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Settings.html#method_reference_container" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">92</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">reference_container</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Engine.html#method_register_sections" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-engine.php"><a href="files/src-admin-layout-class-engine.html"><abbr title="src/admin/layout/class-engine.php">class-engine.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">102</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">register_sections</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Engine.html#method_register_sub_page" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-engine.php"><a href="files/src-admin-layout-class-engine.html"><abbr title="src/admin/layout/class-engine.php">class-engine.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">77</span>
2021-05-01 20:39:33 +00:00
</aside>
<p class="phpdocumentor-summary">Registers a sub-page.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">register_sub_page</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Settings.html#method_scrolling" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">389</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">scrolling</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Settings.html#method_start_end" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">267</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">start_end</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Settings.html#method_superscript" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">575</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">superscript</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Engine.html#method_add_checkbox" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-engine.php"><a href="files/src-admin-layout-class-engine.html"><abbr title="src/admin/layout/class-engine.php">class-engine.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">396</span>
2021-05-01 20:39:33 +00:00
</aside>
2021-05-02 20:27:53 +00:00
<p class="phpdocumentor-summary">Constructs the HTML for a checkbox &#039;input&#039; element.</p>
2021-05-01 20:39:33 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
2021-05-02 20:27:53 +00:00
<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">$setting_name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
2021-05-01 20:39:33 +00:00
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$setting_name</span>
2021-05-01 20:39:33 +00:00
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Setting key.</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">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>protected</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">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Refactor HTML generation.</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_color_selection">
add_color_selection()
<a href="classes/footnotes-admin-layout-Engine.html#method_add_color_selection" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-engine.php"><a href="files/src-admin-layout-class-engine.html"><abbr title="src/admin/layout/class-engine.php">class-engine.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">473</span>
2021-05-01 20:39:33 +00:00
</aside>
2021-05-02 20:27:53 +00:00
<p class="phpdocumentor-summary">Constructs the HTML for a text &#039;input&#039; element with the colour selection
2021-05-01 20:39:33 +00:00
class.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
2021-05-02 20:27:53 +00:00
<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">$setting_name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
2021-05-01 20:39:33 +00:00
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$setting_name</span>
2021-05-01 20:39:33 +00:00
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Setting key.</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">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>protected</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">1.5.6</span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Refactor HTML generation.</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Use proper colorpicker element.</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_label">
add_label()
<a href="classes/footnotes-admin-layout-Engine.html#method_add_label" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-engine.php"><a href="files/src-admin-layout-class-engine.html"><abbr title="src/admin/layout/class-engine.php">class-engine.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">338</span>
2021-05-01 20:39:33 +00:00
</aside>
2021-05-02 20:27:53 +00:00
<p class="phpdocumentor-summary">Returns the HTML tag for a &#039;label&#039; element.</p>
2021-05-01 20:39:33 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
2021-05-02 20:27:53 +00:00
<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">$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">$caption</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
2021-05-01 20:39:33 +00:00
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$setting_name</span>
2021-05-01 20:39:33 +00:00
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Settings key.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$caption</span>
2021-05-01 20:39:33 +00:00
: <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">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>protected</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">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Refactor HTML generation.</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_meta_box">
add_meta_box()
<a href="classes/footnotes-admin-layout-Engine.html#method_add_meta_box" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-engine.php"><a href="files/src-admin-layout-class-engine.html"><abbr title="src/admin/layout/class-engine.php">class-engine.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">279</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<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">$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">$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">$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">$callback_function_name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
2021-05-01 20:39:33 +00:00
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$section_id</span>
2021-05-01 20:39:33 +00:00
: <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">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$id</span>
2021-05-01 20:39:33 +00:00
: <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">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$title</span>
2021-05-01 20:39:33 +00:00
: <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">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$callback_function_name</span>
2021-05-01 20:39:33 +00:00
: <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">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>protected</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">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Refactor meta boxes into their own class?</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Pass actual functions rather than strings?</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>{
A dashboard meta box.</p>
<pre class="prettyprint"><code class="prettyprint">@type string $parent Parent section ID.
@type string $id Meta box ID.
@type string $title Meta box title.
@type string $callback Meta box callback function.
</code></pre>
<p>}</p>
</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-admin-layout-Engine.html#method_add_num_box" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-engine.php"><a href="files/src-admin-layout-class-engine.html"><abbr title="src/admin/layout/class-engine.php">class-engine.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">496</span>
2021-05-01 20:39:33 +00:00
</aside>
2021-05-02 20:27:53 +00:00
<p class="phpdocumentor-summary">Constructs the HTML for numeric &#039;input&#039; element.</p>
2021-05-01 20:39:33 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
2021-05-02 20:27:53 +00:00
<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">$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">$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">$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>
2021-05-01 20:39:33 +00:00
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$setting_name</span>
2021-05-01 20:39:33 +00:00
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Setting key.</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">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$max</span>
2021-05-01 20:39:33 +00:00
: <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">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$deci</span>
2021-05-01 20:39:33 +00:00
: <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><code class="prettyprint">true</code> if float, <code class="prettyprint">false</code> if integer. Default <code class="prettyprint">false</code>.</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">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>protected</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">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Refactor HTML generation.</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_section">
add_section()
<a href="classes/footnotes-admin-layout-Engine.html#method_add_section" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-engine.php"><a href="files/src-admin-layout-class-engine.html"><abbr title="src/admin/layout/class-engine.php">class-engine.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">249</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<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">$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">$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">$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">$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>
2021-05-01 20:39:33 +00:00
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$id</span>
2021-05-01 20:39:33 +00:00
: <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">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$title</span>
2021-05-01 20:39:33 +00:00
: <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">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$settings_container_index</span>
2021-05-01 20:39:33 +00:00
: <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">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$has_submit_button</span>
2021-05-01 20:39:33 +00:00
: <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>Whether a Submit button should
be displayed for this section. Default <code class="prettyprint">true</code>.</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">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>protected</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">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Refactor sections into their own class?</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>{
A dashboard section.</p>
<pre class="prettyprint"><code class="prettyprint">@type string $id Section ID.
@type string $title Section title.
@type bool $submit Whether the section has a submit button or not.
@type int $container Settings Container index.
</code></pre>
<p>}</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-admin-layout-Engine.html#method_add_select_box" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-engine.php"><a href="files/src-admin-layout-class-engine.html"><abbr title="src/admin/layout/class-engine.php">class-engine.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">417</span>
2021-05-01 20:39:33 +00:00
</aside>
2021-05-02 20:27:53 +00:00
<p class="phpdocumentor-summary">Constructs the HTML for a &#039;select&#039; element.</p>
2021-05-01 20:39:33 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
2021-05-02 20:27:53 +00:00
<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">$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">$options</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
2021-05-01 20:39:33 +00:00
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$setting_name</span>
2021-05-01 20:39:33 +00:00
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Setting key.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$options</span>
2021-05-01 20:39:33 +00:00
: <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.</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">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>protected</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">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Refactor HTML generation.</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-admin-layout-Engine.html#method_add_text" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-engine.php"><a href="files/src-admin-layout-class-engine.html"><abbr title="src/admin/layout/class-engine.php">class-engine.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">324</span>
2021-05-01 20:39:33 +00:00
</aside>
2021-05-02 20:27:53 +00:00
<p class="phpdocumentor-summary">Returns a simple text inside a &#039;span&#039; element.</p>
2021-05-01 20:39:33 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
2021-05-02 20:27:53 +00:00
<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">$text</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
2021-05-01 20:39:33 +00:00
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$text</span>
2021-05-01 20:39:33 +00:00
: <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 <code class="prettyprint">&lt;span&gt;</code> tags.</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">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>protected</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">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Refactor HTML generation.</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_box">
add_text_box()
<a href="classes/footnotes-admin-layout-Engine.html#method_add_text_box" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-engine.php"><a href="files/src-admin-layout-class-engine.html"><abbr title="src/admin/layout/class-engine.php">class-engine.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">369</span>
2021-05-01 20:39:33 +00:00
</aside>
2021-05-02 20:27:53 +00:00
<p class="phpdocumentor-summary">Constructs the HTML for a text &#039;input&#039; element.</p>
2021-05-01 20:39:33 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
2021-05-02 20:27:53 +00:00
<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">$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">$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">$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">$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>
2021-05-01 20:39:33 +00:00
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$setting_name</span>
2021-05-01 20:39:33 +00:00
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Setting key.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$max_length</span>
2021-05-01 20:39:33 +00:00
: <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 length 999 chars.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$readonly</span>
2021-05-01 20:39:33 +00:00
: <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 <code class="prettyprint">false</code>.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$hidden</span>
2021-05-01 20:39:33 +00:00
: <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 <code class="prettyprint">false</code>.</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">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>protected</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">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Refactor HTML generation.</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_textarea">
add_textarea()
<a href="classes/footnotes-admin-layout-Engine.html#method_add_textarea" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-engine.php"><a href="files/src-admin-layout-class-engine.html"><abbr title="src/admin/layout/class-engine.php">class-engine.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">451</span>
2021-05-01 20:39:33 +00:00
</aside>
2021-05-02 20:27:53 +00:00
<p class="phpdocumentor-summary">Constructs the HTML for a &#039;textarea&#039; element.</p>
2021-05-01 20:39:33 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
2021-05-02 20:27:53 +00:00
<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">$setting_name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
2021-05-01 20:39:33 +00:00
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$setting_name</span>
2021-05-01 20:39:33 +00:00
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Setting key.</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">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>protected</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">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Refactor HTML generation.</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_get_meta_boxes">
get_meta_boxes()
<a href="classes/footnotes-admin-layout-Settings.html#method_get_meta_boxes" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">1270</span>
2021-05-01 20:39:33 +00:00
</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, array&lt;string|int, mixed&gt;&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">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/footnotes-admin-layout-Engine.html#method_add_meta_box"><abbr title="\footnotes\admin\layout\Engine::add_meta_box()">Engine::add_meta_box()</abbr></a></span>
<section class="phpdocumentor-description"><p>For more information on the
meta box array format.</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">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.2.0</span>
<section class="phpdocumentor-description"><p>Re-order and rename tabs.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, array&lt;string|int, mixed&gt;&gt;</span>
&mdash;
<section class="phpdocumentor-description"><p>All of the registered meta boxes.</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_get_sections">
get_sections()
<a href="classes/footnotes-admin-layout-Settings.html#method_get_sections" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">1245</span>
2021-05-01 20:39:33 +00:00
</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, array&lt;string|int, mixed&gt;&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">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/footnotes-admin-layout-Engine.html#method_add_section"><abbr title="\footnotes\admin\layout\Engine::add_section()">Engine::add_section()</abbr></a></span>
2021-05-02 20:27:53 +00:00
<section class="phpdocumentor-description"><p>For more information on the section array format.</p>
2021-05-01 20:39:33 +00:00
</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">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>Remove conditional rendering of Expert tab.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, array&lt;string|int, mixed&gt;&gt;</span>
&mdash;
<section class="phpdocumentor-description"><p>All of the registered sections.</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-admin-layout-Settings.html#method_get_sub_page_slug" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">1224</span>
2021-05-01 20:39:33 +00:00
</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-admin-layout-Settings.html#method_get_sub_page_title" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-settings.php"><a href="files/src-admin-layout-class-settings.html"><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">1233</span>
2021-05-01 20:39:33 +00:00
</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-admin-layout-Engine.html#method_load_setting" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-engine.php"><a href="files/src-admin-layout-class-engine.html"><abbr title="src/admin/layout/class-engine.php">class-engine.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">305</span>
2021-05-01 20:39:33 +00:00
</aside>
<p class="phpdocumentor-summary">Loads a specified setting.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
2021-05-02 20:27:53 +00:00
<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">$setting_key_name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
2021-05-01 20:39:33 +00:00
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$setting_key_name</span>
2021-05-01 20:39:33 +00:00
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Setting key.</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">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>protected</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">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>Broken due to accidental removal of <code class="prettyprint">esc_attr()</code> call.</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 <code class="prettyprint">esc_attr()</code> call.</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>{
A configurable setting.</p>
<pre class="prettyprint"><code class="prettyprint">@type string $id Setting key.
@type string $name Setting name.
@type string $value Setting value.
</code></pre>
<p>}</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_append_scripts">
append_scripts()
<a href="classes/footnotes-admin-layout-Engine.html#method_append_scripts" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-engine.php"><a href="files/src-admin-layout-class-engine.html"><abbr title="src/admin/layout/class-engine.php">class-engine.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">551</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">append_scripts</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>private</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Move to <abbr title="\footnotes\includes\Admin">Admin</abbr>.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Engine.html#method_register_meta_boxes" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-engine.php"><a href="files/src-admin-layout-class-engine.html"><abbr title="src/admin/layout/class-engine.php">class-engine.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">528</span>
2021-05-01 20:39:33 +00:00
</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>
2021-05-02 20:27:53 +00:00
<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">$parent_id</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__argument__name">$parent_id</span>
2021-05-01 20:39:33 +00:00
: <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">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>private</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&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-admin-layout-Engine.html#method_save_settings" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-engine.php"><a href="files/src-admin-layout-class-engine.html"><abbr title="src/admin/layout/class-engine.php">class-engine.php</abbr></a></abbr>
:
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">567</span>
2021-05-01 20:39:33 +00:00
</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">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>private</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Review nonce verification.</p>
</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"><p><code class="prettyprint">true</code> on save success, else <code class="prettyprint">false</code>.</p>
</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-admin-layout-Settings.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
</body>
</html>