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-Engine.html

2355 lines
116 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">
2021-08-09 10:27:33 +00:00
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
2021-05-01 20:39:33 +00:00
<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" />
2021-08-09 10:27:33 +00:00
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
2021-05-01 20:39:33 +00:00
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -four phpdocumentor-sidebar">
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
2021-08-09 10:27:33 +00:00
<h3 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/default.html"><abbr title="\">Global</abbr></a></h3>
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h4>
2021-05-01 20:39:33 +00:00
<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>
2021-08-09 10:27:33 +00:00
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
2021-05-02 20:27:53 +00:00
<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">
Engine
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-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">32</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">Class to be extended by page layout sub-classes.</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">abstract</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</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">
2021-08-09 10:27:33 +00:00
<a href="classes/footnotes-admin-layout-Engine.html#method_add_settings_sections">add_settings_sections()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Registers all sections for a sub-page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
2021-05-01 20:39:33 +00:00
<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-Engine.html#method_get_priority">get_priority()</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Returns a Priority index. Lower numbers have a higher priority.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
2021-08-09 10:27:33 +00:00
<a href="classes/footnotes-admin-layout-Engine.html#method_register_sub_page">register_sub_page()</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>
2021-08-09 10:27:33 +00:00
<dd>Registers a sub-page.</dd>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/footnotes-admin-layout-Engine.html#method_add_input_checkbox">add_input_checkbox()</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>
2021-08-09 10:27:33 +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">
2021-08-09 10:27:33 +00:00
<a href="classes/footnotes-admin-layout-Engine.html#method_add_input_color">add_input_color()</a>
2021-05-01 20:39:33 +00:00
<span>
2021-08-09 10:27:33 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</dt>
2021-08-09 10:27:33 +00:00
<dd>Constructs the HTML for a color &#039;input&#039; element.</dd>
2021-05-01 20:39:33 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
2021-08-09 10:27:33 +00:00
<a href="classes/footnotes-admin-layout-Engine.html#method_add_input_number">add_input_number()</a>
2021-05-01 20:39:33 +00:00
<span>
2021-08-09 10:27:33 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</dt>
2021-08-09 10:27:33 +00:00
<dd>Constructs the HTML for a numeric &#039;input&#039; element.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/footnotes-admin-layout-Engine.html#method_add_input_text">add_input_text()</a>
<span>
&nbsp;: void </span>
</dt>
<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_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_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">
2021-08-09 10:27:33 +00:00
<a href="classes/footnotes-admin-layout-Engine.html#method_add_select">add_select()</a>
2021-05-01 20:39:33 +00:00
<span>
2021-08-09 10:27:33 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</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">
2021-08-09 10:27:33 +00:00
<a href="classes/footnotes-admin-layout-Engine.html#method_add_settings_fields">add_settings_fields()</a>
2021-05-01 20:39:33 +00:00
<span>
2021-08-09 10:27:33 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</dt>
2021-08-09 10:27:33 +00:00
<dd></dd>
2021-05-01 20:39:33 +00:00
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
2021-08-09 10:27:33 +00:00
<a href="classes/footnotes-admin-layout-Engine.html#method_add_text">add_text()</a>
2021-05-01 20:39:33 +00:00
<span>
&nbsp;: string </span>
</dt>
2021-08-09 10:27:33 +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_textarea">add_textarea()</a>
<span>
2021-08-09 10:27:33 +00:00
&nbsp;: void </span>
2021-05-01 20:39:33 +00:00
</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-Engine.html#method_get_meta_boxes">get_meta_boxes()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Returns an array of all registered meta boxes.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/footnotes-admin-layout-Engine.html#method_get_sections">get_sections()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Returns an array of all registered sections for a sub-page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/footnotes-admin-layout-Engine.html#method_get_sub_page_slug">get_sub_page_slug()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Returns the unique slug of the child sub-page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/footnotes-admin-layout-Engine.html#method_get_sub_page_title">get_sub_page_title()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Returns the title of the child 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>
2021-08-09 10:27:33 +00:00
<dd>Save plugin settings.</dd>
2021-05-01 20:39:33 +00:00
</dl>
<section class="phpdocumentor-properties">
<h3 class="phpdocumentor-elements__header" id="properties">
Properties
<a href="classes/footnotes-admin-layout-Engine.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-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
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
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>The ID of this plugin.</p>
</section>
2021-05-01 20:39:33 +00:00
<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
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</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-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
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
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</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-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
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
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<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
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</dd>
</dl>
</article>
</section>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/footnotes-admin-layout-Engine.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="phpdocumentor-element
-method
-public
"
2021-08-09 10:27:33 +00:00
>
<h4 class="phpdocumentor-element__name" id="method_add_settings_sections">
add_settings_sections()
<a href="classes/footnotes-admin-layout-Engine.html#method_add_settings_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>
:
<span class="phpdocumentor-element-found-in__line">102</span>
</aside>
<p class="phpdocumentor-summary">Registers all sections for a sub-page.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">add_settings_sections</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
</article>
<article
class="phpdocumentor-element
-method
-public
"
2021-05-01 20:39:33 +00:00
>
<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-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">187</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
<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
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +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>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;
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</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-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">118</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
<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
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +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 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;
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</article>
<article
class="phpdocumentor-element
-method
-public
-abstract "
>
<h4 class="phpdocumentor-element__name" id="method_get_priority">
get_priority()
<a href="classes/footnotes-admin-layout-Engine.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-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">71</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">Returns a Priority index. Lower numbers have a higher priority.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">get_priority</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<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">abstract</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int</span>
&mdash;
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
2021-08-09 10:27:33 +00:00
<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>
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-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-08-09 10:27:33 +00:00
<span class="phpdocumentor-element-found-in__line">77</span>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
</aside>
<p class="phpdocumentor-summary">Registers a sub-page.</p>
2021-05-01 20:39:33 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
2021-08-09 10:27:33 +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
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<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>
2021-08-09 10:27:33 +00:00
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;
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</article>
<article
class="phpdocumentor-element
-method
2021-08-09 10:27:33 +00:00
-protected
2021-05-01 20:39:33 +00:00
"
>
2021-08-09 10:27:33 +00:00
<h4 class="phpdocumentor-element__name" id="method_add_input_checkbox">
add_input_checkbox()
<a href="classes/footnotes-admin-layout-Engine.html#method_add_input_checkbox" 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-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-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">493</span>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +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
2021-08-09 10:27:33 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">add_input_checkbox</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$args</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
<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">$args</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Input arguments. @see {Setting::get_setting_field_args()}.</p>
</section>
</dd>
</dl>
2021-05-01 20:39:33 +00:00
<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">
2021-08-09 10:27:33 +00:00
<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">
2021-05-01 20:39:33 +00:00
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">1.5.0</span>
2021-08-09 10:27:33 +00:00
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
<section class="phpdocumentor-description"><p>Rename function from 'add_checkbox' to 'add_input_checkbox'.
Replace 'p_str_setting_name' argument with 'args' array.</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;
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
2021-08-09 10:27:33 +00:00
<h4 class="phpdocumentor-element__name" id="method_add_input_color">
add_input_color()
<a href="classes/footnotes-admin-layout-Engine.html#method_add_input_color" 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-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-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">515</span>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
</aside>
<p class="phpdocumentor-summary">Constructs the HTML for a color &#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-08-09 10:27:33 +00:00
<span class="phpdocumentor-signature__name">add_input_color</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$args</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-signature__argument__name">$args</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
2021-05-01 20:39:33 +00:00
</dt>
<dd class="phpdocumentor-argument-list__definition">
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Input arguments. @see {Setting::get_setting_field_args()}.</p>
2021-05-01 20:39:33 +00:00
</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">
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-tag-link">1.5.6</span>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</dd>
2021-08-09 10:27:33 +00:00
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
2021-05-01 20:39:33 +00:00
</dt>
<dd class="phpdocumentor-tag-list__definition">
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-tag-link">2.8.0</span>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Rename function from 'add_color_selection' to 'add_input_color'.
Replace 'p_str_setting_name' argument with 'args' array.</p>
2021-05-01 20:39:33 +00:00
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&mdash;
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
2021-08-09 10:27:33 +00:00
<h4 class="phpdocumentor-element__name" id="method_add_input_number">
add_input_number()
<a href="classes/footnotes-admin-layout-Engine.html#method_add_input_number" 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-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-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">426</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
<p class="phpdocumentor-summary">Constructs the HTML for a 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-08-09 10:27:33 +00:00
<span class="phpdocumentor-signature__name">add_input_number</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$args</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-signature__argument__name">$args</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
2021-05-01 20:39:33 +00:00
</dt>
<dd class="phpdocumentor-argument-list__definition">
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Input arguments. @see {Setting::get_setting_field_args()}.</p>
2021-05-01 20:39:33 +00:00
</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">
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-tag-link">1.5.0</span>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</dd>
2021-08-09 10:27:33 +00:00
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
2021-05-01 20:39:33 +00:00
</dt>
<dd class="phpdocumentor-tag-list__definition">
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-tag-link">2.1.4</span>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Add step argument and 'number_format()' to allow decimals</p>
2021-05-01 20:39:33 +00:00
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-tag__name">since</span>
2021-05-01 20:39:33 +00:00
</dt>
<dd class="phpdocumentor-tag-list__definition">
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-tag-link">2.8.0</span>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Rename function from 'add_num_box' to 'add_input_number'.
Replace multiple arguments with single 'args' array.</p>
2021-05-01 20:39:33 +00:00
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&mdash;
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
2021-08-09 10:27:33 +00:00
<h4 class="phpdocumentor-element__name" id="method_add_input_text">
add_input_text()
<a href="classes/footnotes-admin-layout-Engine.html#method_add_input_text" 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-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-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">377</span>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
</aside>
<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-08-09 10:27:33 +00:00
<span class="phpdocumentor-signature__name">add_input_text</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$args</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-signature__argument__name">$args</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
2021-05-01 20:39:33 +00:00
</dt>
<dd class="phpdocumentor-argument-list__definition">
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Input arguments. @see {Setting::get_setting_field_args()}.</p>
2021-05-01 20:39:33 +00:00
</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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</dd>
2021-08-09 10:27:33 +00:00
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
2021-05-01 20:39:33 +00:00
</dt>
<dd class="phpdocumentor-tag-list__definition">
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-tag-link">2.8.0</span>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Rename function from 'add_text_box' to 'add_input_text'.
Replace multiple arguments with single 'args' array.</p>
2021-05-01 20:39:33 +00:00
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&mdash;
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
2021-08-09 10:27:33 +00:00
<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>
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-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-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">344</span>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
</aside>
<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-08-09 10:27:33 +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
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
2021-08-09 10:27:33 +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">
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Settings key.</p>
2021-05-01 20:39:33 +00:00
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
2021-08-09 10:27:33 +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">
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Label caption.</p>
2021-05-01 20:39:33 +00:00
</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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Refactor HTML generation.</p>
2021-05-01 20:39:33 +00:00
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-signature__response_type">string</span>
2021-05-01 20:39:33 +00:00
&mdash;
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
2021-08-09 10:27:33 +00:00
<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>
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-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-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">285</span>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
</aside>
<p class="phpdocumentor-summary">Returns an array describing a meta box.</p>
2021-05-01 20:39:33 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
2021-08-09 10:27:33 +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
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
2021-08-09 10:27:33 +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">
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Parent section ID.</p>
2021-05-01 20:39:33 +00:00
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-signature__argument__name">$id</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
2021-05-01 20:39:33 +00:00
</dt>
<dd class="phpdocumentor-argument-list__definition">
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Unique ID suffix.</p>
2021-05-01 20:39:33 +00:00
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-signature__argument__name">$title</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
2021-05-01 20:39:33 +00:00
</dt>
<dd class="phpdocumentor-argument-list__definition">
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Title for the meta box.</p>
2021-05-01 20:39:33 +00:00
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-signature__argument__name">$callback_function_name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
2021-05-01 20:39:33 +00:00
<dd class="phpdocumentor-argument-list__definition">
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Class method name for callback.</p>
2021-05-01 20:39:33 +00:00
</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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
2021-08-09 10:27:33 +00:00
<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>
2021-05-01 20:39:33 +00:00
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
2021-05-01 20:39:33 +00:00
&mdash;
2021-08-09 10:27:33 +00:00
<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>
2021-05-01 20:39:33 +00:00
</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-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">255</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
<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
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +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>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
"
>
2021-08-09 10:27:33 +00:00
<h4 class="phpdocumentor-element__name" id="method_add_select">
add_select()
<a href="classes/footnotes-admin-layout-Engine.html#method_add_select" 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-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-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">452</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
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-08-09 10:27:33 +00:00
<span class="phpdocumentor-signature__name">add_select</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$args</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-signature__argument__name">$args</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">
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Input arguments. @see {Setting::get_setting_field_args()}.</p>
2021-05-01 20:39:33 +00:00
</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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</dd>
2021-08-09 10:27:33 +00:00
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
2021-05-01 20:39:33 +00:00
</dt>
<dd class="phpdocumentor-tag-list__definition">
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-tag-link">2.8.0</span>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Rename function from 'add_select_box' to 'add_select'.
Replace multiple arguments with single 'args' array.</p>
2021-05-01 20:39:33 +00:00
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&mdash;
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</article>
<article
class="phpdocumentor-element
-method
-protected
2021-08-09 10:27:33 +00:00
-abstract "
2021-05-01 20:39:33 +00:00
>
2021-08-09 10:27:33 +00:00
<h4 class="phpdocumentor-element__name" id="method_add_settings_fields">
add_settings_fields()
<a href="classes/footnotes-admin-layout-Engine.html#method_add_settings_fields" 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-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-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">232</span>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">add_settings_fields</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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&mdash;
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
2021-08-09 10:27:33 +00:00
<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>
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-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-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">330</span>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
</aside>
<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-08-09 10:27:33 +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
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
2021-08-09 10:27:33 +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">
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Message to be surrounded with <code class="prettyprint">&lt;span&gt;</code> tags.</p>
2021-05-01 20:39:33 +00:00
</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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +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>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;
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</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-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">401</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
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-08-09 10:27:33 +00:00
<span class="phpdocumentor-signature__name">add_textarea</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$args</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-signature__argument__name">$args</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
2021-05-01 20:39:33 +00:00
</dt>
<dd class="phpdocumentor-argument-list__definition">
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Input arguments. @see {Setting::get_setting_field_args()}.</p>
2021-05-01 20:39:33 +00:00
</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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</dd>
2021-08-09 10:27:33 +00:00
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
2021-05-01 20:39:33 +00:00
</dt>
<dd class="phpdocumentor-tag-list__definition">
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-tag-link">2.8.0</span>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"><p>Replace 'p_str_setting_name' argument with 'args' array.</p>
2021-05-01 20:39:33 +00:00
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
2021-05-01 20:39:33 +00:00
&mdash;
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</article>
<article
class="phpdocumentor-element
-method
-protected
-abstract "
>
<h4 class="phpdocumentor-element__name" id="method_get_meta_boxes">
get_meta_boxes()
<a href="classes/footnotes-admin-layout-Engine.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-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-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">229</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">Returns an array of all registered meta boxes.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">get_meta_boxes</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<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">abstract</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</dd>
<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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</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;
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</article>
<article
class="phpdocumentor-element
-method
-protected
-abstract "
>
<h4 class="phpdocumentor-element__name" id="method_get_sections">
get_sections()
<a href="classes/footnotes-admin-layout-Engine.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-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-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">219</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">Returns an array of all registered sections for a sub-page.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">get_sections</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<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">abstract</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</dd>
<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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</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;
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</article>
<article
class="phpdocumentor-element
-method
-protected
-abstract "
>
<h4 class="phpdocumentor-element__name" id="method_get_sub_page_slug">
get_sub_page_slug()
<a href="classes/footnotes-admin-layout-Engine.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-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-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">199</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">Returns the unique slug of the child sub-page.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__abstract">abstract</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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<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">abstract</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</dd>
<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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</article>
<article
class="phpdocumentor-element
-method
-protected
-abstract "
>
<h4 class="phpdocumentor-element__name" id="method_get_sub_page_title">
get_sub_page_title()
<a href="classes/footnotes-admin-layout-Engine.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-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-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">209</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">Returns the title of the child sub-page.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__abstract">abstract</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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<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">abstract</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</dd>
<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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</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-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">311</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
<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
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</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-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">561</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
<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
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +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>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;
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</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-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">538</span>
2021-08-09 10:27:33 +00:00
</aside>
2021-05-01 20:39:33 +00:00
<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
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<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>
2021-08-09 10:27:33 +00:00
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;
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
</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-08-09 10:49:15 +00:00
<span class="phpdocumentor-element-found-in__line">580</span>
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
</aside>
<p class="phpdocumentor-summary">Save plugin settings.</p>
2021-05-01 20:39:33 +00:00
<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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
<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>
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +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 nonce verification.</p>
</section>
2021-08-09 10:27:33 +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>New settings require a page refresh to render correctly. Fix.</p>
</section>
2021-05-01 20:39:33 +00:00
</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>
2021-08-09 10:27:33 +00:00
<script type="text/javascript">
function loadExternalCodeSnippets(line) {
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
var src = pre.getAttribute('data-src').replace( /\\/g, '/');
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
var language = 'php';
var code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
}
else if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
}
else {
code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
}
}
};
xhr.send(null);
});
}
var modals = document.querySelectorAll("[data-modal]");
modals.forEach(function (trigger) {
trigger.addEventListener("click", function (event) {
//event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippets(trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
</script>
2021-05-01 20:39:33 +00:00
</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-Engine.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
2021-08-09 10:27:33 +00:00
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
2021-05-01 20:39:33 +00:00
</body>
</html>