2021-08-09 10:27:33 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > Documentation< / title >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< base href = "../" >
< link rel = "icon" href = "images/favicon.ico" / >
< link rel = "stylesheet" href = "css/normalize.css" >
< link rel = "stylesheet" href = "css/base.css" >
< link rel = "preconnect" href = "https://fonts.gstatic.com" >
< link href = "https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel = "stylesheet" >
< link href = "https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel = "stylesheet" >
< link rel = "stylesheet" href = "css/template.css" >
< link rel = "stylesheet" href = "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity = "sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin = "anonymous" / >
< link rel = "stylesheet" href = "https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css" >
< link rel = "stylesheet" href = "https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css" >
< link rel = "stylesheet" href = "https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css" >
< script src = "https://cdn.jsdelivr.net/npm/fuse.js@3.4.6" > < / script >
< script src = "https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2" > < / script >
< script src = "js/search.js" > < / script >
< script defer src = "js/searchIndex.js" > < / script >
< / head >
< body id = "top" >
< header class = "phpdocumentor-header phpdocumentor-section" >
< h1 class = "phpdocumentor-title" > < a href = "" class = "phpdocumentor-title__link" > Documentation< / a > < / h1 >
< input class = "phpdocumentor-header__menu-button" type = "checkbox" id = "menu-button" name = "menu-button" / >
< label class = "phpdocumentor-header__menu-icon" for = "menu-button" >
< i class = "fas fa-bars" > < / i >
< / label >
< section data-search-form class = "phpdocumentor-search" >
< label >
< span class = "visually-hidden" > Search for< / span >
< svg class = "phpdocumentor-search__icon" width = "21" height = "20" viewBox = "0 0 21 20" fill = "none" xmlns = "http://www.w3.org/2000/svg" >
< circle cx = "7.5" cy = "7.5" r = "6.5" stroke = "currentColor" stroke-width = "2" / >
< line x1 = "12.4892" y1 = "12.2727" x2 = "19.1559" y2 = "18.9393" stroke = "currentColor" stroke-width = "3" / >
< / svg >
< input type = "search" class = "phpdocumentor-field phpdocumentor-search__field" placeholder = "Loading .." disabled / >
< / label >
< / section >
< nav class = "phpdocumentor-topnav" >
< ul class = "phpdocumentor-topnav__menu" >
< / ul >
< / nav >
< / header >
< main class = "phpdocumentor" >
< div class = "phpdocumentor-section" >
< input class = "phpdocumentor-sidebar__menu-button" type = "checkbox" id = "sidebar-button" name = "sidebar-button" / >
< label class = "phpdocumentor-sidebar__menu-icon" for = "sidebar-button" >
Menu
< / label >
< aside class = "phpdocumentor-column -four phpdocumentor-sidebar" >
< section class = "phpdocumentor-sidebar__category" >
< h2 class = "phpdocumentor-sidebar__category-header" > Namespaces< / h2 >
< h3 class = "phpdocumentor-sidebar__root-namespace" > < a href = "namespaces/default.html" > < abbr title = "\" > Global< / abbr > < / a > < / h3 >
< h4 class = "phpdocumentor-sidebar__root-namespace" > < a href = "namespaces/footnotes.html" > < abbr title = "\footnotes" > footnotes< / abbr > < / a > < / h4 >
< ul class = "phpdocumentor-list" >
< li > < a href = "namespaces/footnotes-admin.html" > < abbr title = "\footnotes\admin" > admin< / abbr > < / a > < / li >
< li > < a href = "namespaces/footnotes-includes.html" > < abbr title = "\footnotes\includes" > includes< / abbr > < / a > < / li >
< li > < a href = "namespaces/footnotes-general.html" > < abbr title = "\footnotes\general" > general< / abbr > < / a > < / li >
< / ul >
< / section >
< section class = "phpdocumentor-sidebar__category" >
< h2 class = "phpdocumentor-sidebar__category-header" > Packages< / h2 >
< h3 class = "phpdocumentor-sidebar__root-package" > < a href = "packages/footnotes.html" > < abbr title = "\footnotes" > footnotes< / abbr > < / a > < / h3 >
< ul class = "phpdocumentor-list" >
< li > < a href = "packages/footnotes-includes.html" > < abbr title = "\footnotes\includes" > includes< / abbr > < / a > < / li >
< / ul >
< / section >
< section class = "phpdocumentor-sidebar__category" >
< h2 class = "phpdocumentor-sidebar__category-header" > Reports< / h2 >
< h3 class = "phpdocumentor-sidebar__root-package" > < a href = "reports/deprecated.html" > Deprecated< / a > < / h3 >
< h3 class = "phpdocumentor-sidebar__root-package" > < a href = "reports/errors.html" > Errors< / a > < / h3 >
< h3 class = "phpdocumentor-sidebar__root-package" > < a href = "reports/markers.html" > Markers< / a > < / h3 >
< / section >
< section class = "phpdocumentor-sidebar__category" >
< h2 class = "phpdocumentor-sidebar__category-header" > Indices< / h2 >
< h3 class = "phpdocumentor-sidebar__root-package" > < a href = "indices/files.html" > Files< / a > < / h3 >
< / section >
< / aside >
< div class = "phpdocumentor-column -eight phpdocumentor-content" >
< ul class = "phpdocumentor-breadcrumbs" >
< li class = "phpdocumentor-breadcrumb" > < a href = "namespaces/footnotes.html" > footnotes< / a > < / li >
< li class = "phpdocumentor-breadcrumb" > < a href = "namespaces/footnotes-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" >
SettingsPage
< span class = "phpdocumentor-element__extends" >
extends < a href = "classes/footnotes-admin-layout-Engine.html" > < abbr title = "\footnotes\admin\layout\Engine" > Engine< / abbr > < / a >
< / span >
< div class = "phpdocumentor-element__package" >
in package
< ul class = "phpdocumentor-breadcrumbs" >
< li class = "phpdocumentor-breadcrumb" > < a href = "packages/footnotes.html" > footnotes< / a > < / li >
< / ul >
< / div >
< / h2 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/admin/layout/class-settings-page.php" > < a href = "files/src-admin-layout-class-settings-page.html" > < abbr title = "src/admin/layout/class-settings-page.php" > class-settings-page.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 39< / span >
< / aside >
< p class = "phpdocumentor-summary" > Class to initialise all defined page layouts.< / p >
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 1.5.0< / span >
< / dd >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 2.8.0< / span >
< section class = "phpdocumentor-description" > < p > Rename class from < code class = "prettyprint" > Settings< / code > to < code class = "prettyprint" > SettingsPage< / code > .< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > see< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > < a href = "classes/footnotes-admin-layout-Engine.html" > < abbr title = "\footnotes\admin\layout\Engine" > Engine< / abbr > < / a > < / span >
< / dd >
< / dl >
< h3 id = "toc" >
Table of Contents
< a href = "#toc" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h3 >
< dl class = "phpdocumentor-table-of-contents" >
< dt class = "phpdocumentor-table-of-contents__entry -property -protected" >
< a href = "classes/footnotes-admin-layout-SettingsPage.html#property_plugin_name" > $plugin_name< / a >
< span >
: string < / span >
< / dt >
< dd > The ID of this plugin.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -property -protected" >
< a href = "classes/footnotes-admin-layout-Engine.html#property_sections" > $sections< / a >
< span >
: array< string|int, mixed> < / span >
< / dt >
< dd > Stores all Sections for the child sub-page.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -property -protected" >
< a href = "classes/footnotes-admin-layout-SettingsPage.html#property_settings" > $settings< / a >
< span >
: < a href = "classes/footnotes-includes-Settings.html" > < abbr title = "\footnotes\includes\Settings" > Settings< / abbr > < / a > < / span >
< / dt >
< dd > The plugin settings object.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -property -protected" >
< a href = "classes/footnotes-admin-layout-Engine.html#property_sub_page_hook" > $sub_page_hook< / a >
< span >
: string|null < / span >
< / dt >
< dd > Stores the Hook connection string for the child sub-page.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/footnotes-admin-layout-SettingsPage.html#method___construct" > __construct()< / a >
< span >
: mixed < / span >
< / dt >
< dd > Initialize the class and set its properties.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/footnotes-admin-layout-SettingsPage.html#method_add_settings_fields" > add_settings_fields()< / a >
< span >
: void < / span >
< / dt >
< dd > < / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/footnotes-admin-layout-Engine.html#method_add_settings_sections" > add_settings_sections()< / a >
< span >
: void < / span >
< / dt >
< dd > Registers all sections for a sub-page.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/footnotes-admin-layout-Engine.html#method_description" > description()< / a >
< span >
: void < / span >
< / dt >
< dd > Output the description of a section. May be overwritten in any section.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/footnotes-admin-layout-Engine.html#method_display_content" > display_content()< / a >
< span >
: void < / span >
< / 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-SettingsPage.html#method_donate" > donate()< / a >
< span >
: void < / span >
< / dt >
< dd > Displays all Donate button to support the developers.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/footnotes-admin-layout-SettingsPage.html#method_get_priority" > get_priority()< / a >
< span >
: int < / span >
< / dt >
< dd > Returns a priority index.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/footnotes-admin-layout-SettingsPage.html#method_help" > help()< / a >
< span >
: void < / span >
< / dt >
< dd > Displays a short introduction to the plugin.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/footnotes-admin-layout-Engine.html#method_register_sub_page" > register_sub_page()< / a >
< span >
: void < / span >
< / dt >
< dd > Registers a sub-page.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/footnotes-admin-layout-SettingsPage.html#method_setting_field_callback" > setting_field_callback()< / a >
< span >
: void < / span >
< / dt >
< dd > < / dd >
< 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 >
< span >
: void < / span >
< / dt >
< dd > Constructs the HTML for a checkbox ' input' element.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/footnotes-admin-layout-Engine.html#method_add_input_color" > add_input_color()< / a >
< span >
: void < / span >
< / dt >
< dd > Constructs the HTML for a color ' input' element.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/footnotes-admin-layout-Engine.html#method_add_input_number" > add_input_number()< / a >
< span >
: void < / span >
< / dt >
< dd > Constructs the HTML for a numeric ' input' 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 >
: void < / span >
< / dt >
< dd > Constructs the HTML for a text ' input' element.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/footnotes-admin-layout-Engine.html#method_add_label" > add_label()< / a >
< span >
: string < / span >
< / dt >
< dd > Returns the HTML tag for a ' label' element.< / dd >
< 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 >
: array< string|int, mixed> < / 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 >
: array< string|int, mixed> < / span >
< / dt >
< dd > Returns an array describing a sub-page section.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/footnotes-admin-layout-Engine.html#method_add_select" > add_select()< / a >
< span >
: void < / span >
< / dt >
< dd > Constructs the HTML for a ' select' element.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/footnotes-admin-layout-Engine.html#method_add_text" > add_text()< / a >
< span >
: string < / span >
< / dt >
< dd > Returns a simple text inside a ' span' element.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/footnotes-admin-layout-Engine.html#method_add_textarea" > add_textarea()< / a >
< span >
: void < / span >
< / dt >
< dd > Constructs the HTML for a ' textarea' element.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/footnotes-admin-layout-SettingsPage.html#method_get_meta_boxes" > get_meta_boxes()< / a >
< span >
: array< string|int, array< string|int, mixed> > < / span >
< / dt >
< dd > Returns an array of all registered meta boxes for each section of the sub-page.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/footnotes-admin-layout-SettingsPage.html#method_get_sections" > get_sections()< / a >
< span >
: array< string|int, array< string|int, mixed> > < / span >
< / dt >
< dd > Returns an array of all registered sections for the sub-page.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/footnotes-admin-layout-SettingsPage.html#method_get_sub_page_slug" > get_sub_page_slug()< / a >
< span >
: string < / span >
< / dt >
< dd > Returns the unique slug of the sub-page.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/footnotes-admin-layout-SettingsPage.html#method_get_sub_page_title" > get_sub_page_title()< / a >
< span >
: string < / span >
< / dt >
< dd > Returns the title of the sub-page.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/footnotes-admin-layout-Engine.html#method_load_setting" > load_setting()< / a >
< span >
: array< string|int, mixed> < / 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 >
: void < / span >
< / dt >
< dd > Append JavaScript and CSS files for specific sub-page.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -private" >
< a href = "classes/footnotes-admin-layout-Engine.html#method_register_meta_boxes" > register_meta_boxes()< / a >
< span >
: void < / span >
< / dt >
< dd > Registers all Meta boxes for a sub-page.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -private" >
< a href = "classes/footnotes-admin-layout-Engine.html#method_save_settings" > save_settings()< / a >
< span >
: bool < / span >
< / dt >
< dd > Save plugin settings.< / dd >
< / dl >
< section class = "phpdocumentor-properties" >
< h3 class = "phpdocumentor-elements__header" id = "properties" >
Properties
< a href = "classes/footnotes-admin-layout-SettingsPage.html#properties" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h3 >
< article
class="
phpdocumentor-element
-property
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "property_plugin_name" >
$plugin_name
< a href = "classes/footnotes-admin-layout-SettingsPage.html#property_plugin_name" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< span class = "phpdocumentor-element__modifiers" >
< / span >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/admin/layout/class-settings-page.php" > < a href = "files/src-admin-layout-class-settings-page.html" > < abbr title = "src/admin/layout/class-settings-page.php" > class-settings-page.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 55< / span >
< / aside >
< p class = "phpdocumentor-summary" > The ID of this plugin.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__type" > string< / span >
< span class = "phpdocumentor-signature__name" > $plugin_name< / span >
< / code >
< section class = "phpdocumentor-description" > < p > The ID of this plugin.< / p >
< / section >
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > access< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< section class = "phpdocumentor-description" > < p > private< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 2.8.0< / span >
< / dd >
< / dl >
< / article >
< article
class="
phpdocumentor-element
-property
-protected
"
>
< 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 >
< 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 >
:
< span class = "phpdocumentor-element-found-in__line" > 62< / span >
< / aside >
< p class = "phpdocumentor-summary" > Stores all Sections for the child sub-page.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__type" > array< string|int, mixed> < / span >
< span class = "phpdocumentor-signature__name" > $sections< / span >
= < span class = "phpdocumentor-signature__default-value" > array()< / 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" > 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 >
< / dd >
< / dl >
< / article >
< article
class="
phpdocumentor-element
-property
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "property_settings" >
$settings
< a href = "classes/footnotes-admin-layout-SettingsPage.html#property_settings" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< span class = "phpdocumentor-element__modifiers" >
< / span >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/admin/layout/class-settings-page.php" > < a href = "files/src-admin-layout-class-settings-page.html" > < abbr title = "src/admin/layout/class-settings-page.php" > class-settings-page.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 63< / span >
< / aside >
< p class = "phpdocumentor-summary" > The plugin settings object.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__type" > < a href = "classes/footnotes-includes-Settings.html" > < abbr title = "\footnotes\includes\Settings" > Settings< / abbr > < / a > < / span >
< span class = "phpdocumentor-signature__name" > $settings< / span >
< / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > access< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< section class = "phpdocumentor-description" > < p > private< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 2.8.0< / span >
< / dd >
< / dl >
< / article >
< article
class="
phpdocumentor-element
-property
-protected
"
>
< 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 >
< 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 >
:
< span class = "phpdocumentor-element-found-in__line" > 52< / span >
< / aside >
< p class = "phpdocumentor-summary" > Stores the Hook connection string for the child sub-page.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__type" > string|null< / span >
< span class = "phpdocumentor-signature__name" > $sub_page_hook< / span >
= < span class = "phpdocumentor-signature__default-value" > null< / 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" > 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 >
< / dd >
< / dl >
< / article >
< / section >
< section class = "phpdocumentor-methods" >
< h3 class = "phpdocumentor-elements__header" id = "methods" >
Methods
< a href = "classes/footnotes-admin-layout-SettingsPage.html#methods" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h3 >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method___construct" >
__construct()
< a href = "classes/footnotes-admin-layout-SettingsPage.html#method___construct" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/admin/layout/class-settings-page.php" > < a href = "files/src-admin-layout-class-settings-page.html" > < abbr title = "src/admin/layout/class-settings-page.php" > class-settings-page.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 46< / span >
< / aside >
< p class = "phpdocumentor-summary" > Initialize the class and set its properties.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__name" > __construct< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $plugin_name< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > < a href = "classes/footnotes-includes-Settings.html" > < abbr title = "\footnotes\includes\Settings" > Settings< / abbr > < / a > < / span > < span class = "phpdocumentor-signature__argument__name" > $settings< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > mixed< / span > < / code >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $plugin_name< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $settings< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > < a href = "classes/footnotes-includes-Settings.html" > < abbr title = "\footnotes\includes\Settings" > Settings< / abbr > < / a > < / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 2.8.0< / span >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > mixed< / span >
—
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_add_settings_fields" >
add_settings_fields()
< a href = "classes/footnotes-admin-layout-SettingsPage.html#method_add_settings_fields" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/admin/layout/class-settings-page.php" > < a href = "files/src-admin-layout-class-settings-page.html" > < abbr title = "src/admin/layout/class-settings-page.php" > class-settings-page.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 83< / span >
< / aside >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__name" > add_settings_fields< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > void< / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > void< / span >
—
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_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 >
—
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_description" >
description()
< a href = "classes/footnotes-admin-layout-Engine.html#method_description" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/admin/layout/class-engine.php" > < a href = "files/src-admin-layout-class-engine.html" > < abbr title = "src/admin/layout/class-engine.php" > class-engine.php< / abbr > < / a > < / abbr >
:
2021-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 >
< p class = "phpdocumentor-summary" > Output the description of a section. May be overwritten in any section.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__name" > description< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > 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 >
< 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 >
< span class = "phpdocumentor-signature__response_type" > void< / span >
—
< / 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 >
< p class = "phpdocumentor-summary" > Displays the content of specific sub-page.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__name" > display_content< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > 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 >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > todo< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< section class = "phpdocumentor-description" > < p > Review nonce verification.< / p >
< / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > void< / span >
—
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_donate" >
donate()
< a href = "classes/footnotes-admin-layout-SettingsPage.html#method_donate" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/admin/layout/class-settings-page.php" > < a href = "files/src-admin-layout-class-settings-page.html" > < abbr title = "src/admin/layout/class-settings-page.php" > class-settings-page.php< / abbr > < / a > < / abbr >
:
2021-08-09 10:49:15 +00:00
< span class = "phpdocumentor-element-found-in__line" > 214< / span >
2021-08-09 10:27:33 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Displays all Donate button to support the developers.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__name" > donate< / 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 >
—
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_get_priority" >
get_priority()
< a href = "classes/footnotes-admin-layout-SettingsPage.html#method_get_priority" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/admin/layout/class-settings-page.php" > < a href = "files/src-admin-layout-class-settings-page.html" > < abbr title = "src/admin/layout/class-settings-page.php" > class-settings-page.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 75< / span >
< / aside >
< p class = "phpdocumentor-summary" > Returns a priority index.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__name" > get_priority< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > int< / span > < / code >
< section class = "phpdocumentor-description" > < p > Lower numbers have a higher priority.< / p >
< / section >
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 1.5.0< / span >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > int< / span >
—
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_help" >
help()
< a href = "classes/footnotes-admin-layout-SettingsPage.html#method_help" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/admin/layout/class-settings-page.php" > < a href = "files/src-admin-layout-class-settings-page.html" > < abbr title = "src/admin/layout/class-settings-page.php" > class-settings-page.php< / abbr > < / a > < / abbr >
:
2021-08-09 10:49:15 +00:00
< span class = "phpdocumentor-element-found-in__line" > 149< / span >
2021-08-09 10:27:33 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Displays a short introduction to the plugin.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__name" > help< / 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 >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > todo< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< section class = "phpdocumentor-description" > < p > Review in light of admin/public split.< / p >
< / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > void< / span >
—
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_register_sub_page" >
register_sub_page()
< a href = "classes/footnotes-admin-layout-Engine.html#method_register_sub_page" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/admin/layout/class-engine.php" > < a href = "files/src-admin-layout-class-engine.html" > < abbr title = "src/admin/layout/class-engine.php" > class-engine.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 77< / span >
< / aside >
< p class = "phpdocumentor-summary" > Registers a sub-page.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__name" > register_sub_page< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > 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 >
—
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_setting_field_callback" >
setting_field_callback()
< a href = "classes/footnotes-admin-layout-SettingsPage.html#method_setting_field_callback" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/admin/layout/class-settings-page.php" > < a href = "files/src-admin-layout-class-settings-page.html" > < abbr title = "src/admin/layout/class-settings-page.php" > class-settings-page.php< / abbr > < / a > < / abbr >
:
2021-08-09 10:49:15 +00:00
< span class = "phpdocumentor-element-found-in__line" > 108< / span >
2021-08-09 10:27:33 +00:00
< / aside >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__name" > setting_field_callback< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > array< string|int, mixed> < / span > < span class = "phpdocumentor-signature__argument__name" > $args< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > void< / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $args< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > array< string|int, mixed> < / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > void< / span >
—
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< 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 >
< / 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-08-09 10:27:33 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Constructs the HTML for a checkbox ' input' element.< / p >
< 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< string|int, mixed> < / span > < span class = "phpdocumentor-signature__argument__name" > $args< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > void< / span > < / code >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $args< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > array< string|int, mixed> < / 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 >
< 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 >
< / 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 >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > void< / span >
—
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_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 >
< / 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-08-09 10:27:33 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Constructs the HTML for a color ' input' element.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > add_input_color< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > array< string|int, mixed> < / span > < span class = "phpdocumentor-signature__argument__name" > $args< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > void< / span > < / code >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $args< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > array< string|int, mixed> < / 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 >
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > access< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< section class = "phpdocumentor-description" > < p > protected< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 1.5.6< / span >
< / 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_color_selection' to 'add_input_color'.
Replace 'p_str_setting_name' argument with 'args' array.< / p >
< / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > void< / span >
—
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< 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 >
< / 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 >
< p class = "phpdocumentor-summary" > Constructs the HTML for a numeric ' input' element.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > add_input_number< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > array< string|int, mixed> < / span > < span class = "phpdocumentor-signature__argument__name" > $args< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > void< / span > < / code >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $args< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > array< string|int, mixed> < / 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 >
< 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 >
< / dd >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 2.1.4< / span >
< section class = "phpdocumentor-description" > < p > Add step argument and 'number_format()' to allow decimals< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 2.8.0< / span >
< section class = "phpdocumentor-description" > < p > Rename function from 'add_num_box' to 'add_input_number'.
Replace multiple arguments with single 'args' array.< / p >
< / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > void< / span >
—
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< 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 >
< / 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-08-09 10:27:33 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Constructs the HTML for a text ' input' element.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > add_input_text< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > array< string|int, mixed> < / span > < span class = "phpdocumentor-signature__argument__name" > $args< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > void< / span > < / code >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $args< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > array< string|int, mixed> < / 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 >
< 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 >
< / 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_text_box' to 'add_input_text'.
Replace multiple arguments with single 'args' array.< / p >
< / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > void< / span >
—
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_add_label" >
add_label()
< a href = "classes/footnotes-admin-layout-Engine.html#method_add_label" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/admin/layout/class-engine.php" > < a href = "files/src-admin-layout-class-engine.html" > < abbr title = "src/admin/layout/class-engine.php" > class-engine.php< / abbr > < / a > < / abbr >
:
2021-08-09 10:49:15 +00:00
< span class = "phpdocumentor-element-found-in__line" > 344< / span >
2021-08-09 10:27:33 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Returns the HTML tag for a ' label' element.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > add_label< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / 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 < / span > < span class = "phpdocumentor-signature__argument__name" > $caption< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > string< / span > < / code >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $setting_name< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > Settings key.< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $caption< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > Label caption.< / p >
< / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > 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 >
< / 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 >
—
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_add_meta_box" >
add_meta_box()
< a href = "classes/footnotes-admin-layout-Engine.html#method_add_meta_box" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/admin/layout/class-engine.php" > < a href = "files/src-admin-layout-class-engine.html" > < abbr title = "src/admin/layout/class-engine.php" > class-engine.php< / abbr > < / a > < / abbr >
:
2021-08-09 10:49:15 +00:00
< span class = "phpdocumentor-element-found-in__line" > 285< / span >
2021-08-09 10:27:33 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Returns an array describing a meta box.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > add_meta_box< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / 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 < / 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 < / 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 < / span > < span class = "phpdocumentor-signature__argument__name" > $callback_function_name< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > array< string|int, mixed> < / span > < / code >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $section_id< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > Parent section ID.< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $id< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > Unique ID suffix.< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $title< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > Title for the meta box.< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $callback_function_name< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > Class method name for callback.< / p >
< / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > 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 >
< / dd >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > todo< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< section class = "phpdocumentor-description" > < p > Refactor meta boxes into their own class?< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > todo< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< section class = "phpdocumentor-description" > < p > Pass actual functions rather than strings?< / p >
< / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > array< string|int, mixed> < / span >
—
< section class = "phpdocumentor-description" > < p > {
A dashboard meta box.< / p >
< pre class = "prettyprint" > < code class = "prettyprint" > @type string $parent Parent section ID.
@type string $id Meta box ID.
@type string $title Meta box title.
@type string $callback Meta box callback function.
< / code > < / pre >
< p > }< / p >
< / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_add_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 >
< p class = "phpdocumentor-summary" > Returns an array describing a sub-page section.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > add_section< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / 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 < / 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 < / 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 < / 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< string|int, mixed> < / span > < / code >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $id< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > Unique ID suffix.< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $title< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > Title of the section.< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $settings_container_index< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > int< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > Settings Container index.< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $has_submit_button< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > bool< / span >
= < span class = "phpdocumentor-signature__argument__default-value" > true< / span > < / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > Whether a ‘ ’
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 >
< / 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< string|int, mixed> < / span >
—
< section class = "phpdocumentor-description" > < p > {
A dashboard section.< / p >
< pre class = "prettyprint" > < code class = "prettyprint" > @type string $id Section ID.
@type string $title Section title.
@type bool $submit Whether the section has a submit button or not.
@type int $container Settings Container index.
< / code > < / pre >
< p > }< / p >
< / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_add_select" >
add_select()
< a href = "classes/footnotes-admin-layout-Engine.html#method_add_select" 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" > 452< / span >
2021-08-09 10:27:33 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Constructs the HTML for a ' select' element.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > add_select< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > array< string|int, mixed> < / span > < span class = "phpdocumentor-signature__argument__name" > $args< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > void< / span > < / code >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $args< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > array< string|int, mixed> < / 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 >
< 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 >
< / 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_select_box' to 'add_select'.
Replace multiple arguments with single 'args' array.< / p >
< / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > void< / span >
—
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_add_text" >
add_text()
< a href = "classes/footnotes-admin-layout-Engine.html#method_add_text" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/admin/layout/class-engine.php" > < a href = "files/src-admin-layout-class-engine.html" > < abbr title = "src/admin/layout/class-engine.php" > class-engine.php< / abbr > < / a > < / abbr >
:
2021-08-09 10:49:15 +00:00
< span class = "phpdocumentor-element-found-in__line" > 330< / span >
2021-08-09 10:27:33 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Returns a simple text inside a ' span' element.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > add_text< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $text< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > string< / span > < / code >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $text< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > Message to be surrounded with < code class = "prettyprint" > < span> < / code > tags.< / p >
< / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > access< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< section class = "phpdocumentor-description" > < p > protected< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 1.5.0< / span >
< / 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 >
—
< / 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 >
< p class = "phpdocumentor-summary" > Constructs the HTML for a ' textarea' element.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > add_textarea< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > array< string|int, mixed> < / span > < span class = "phpdocumentor-signature__argument__name" > $args< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > void< / span > < / code >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $args< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > array< string|int, mixed> < / 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 >
< 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 >
< / 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 > Replace 'p_str_setting_name' argument with 'args' array.< / p >
< / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > void< / span >
—
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_get_meta_boxes" >
get_meta_boxes()
< a href = "classes/footnotes-admin-layout-SettingsPage.html#method_get_meta_boxes" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/admin/layout/class-settings-page.php" > < a href = "files/src-admin-layout-class-settings-page.html" > < abbr title = "src/admin/layout/class-settings-page.php" > class-settings-page.php< / abbr > < / a > < / abbr >
:
2021-08-09 10:49:15 +00:00
< span class = "phpdocumentor-element-found-in__line" > 280< / span >
2021-08-09 10:27:33 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Returns an array of all registered meta boxes for each section of the sub-page.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > get_meta_boxes< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > array< string|int, array< string|int, mixed> > < / span > < / code >
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > see< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > < a href = "classes/footnotes-admin-layout-Engine.html#method_add_meta_box" > < abbr title = "\footnotes\admin\layout\Engine::add_meta_box()" > Engine::add_meta_box()< / abbr > < / a > < / span >
< section class = "phpdocumentor-description" > < p > For more information on the
meta box array format.< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 1.5.0< / span >
< / dd >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 2.2.0< / span >
< section class = "phpdocumentor-description" > < p > Re-order and rename tabs.< / p >
< / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > array< string|int, array< string|int, mixed> > < / span >
—
< section class = "phpdocumentor-description" > < p > All of the registered meta boxes.< / p >
< / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_get_sections" >
get_sections()
< a href = "classes/footnotes-admin-layout-SettingsPage.html#method_get_sections" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/admin/layout/class-settings-page.php" > < a href = "files/src-admin-layout-class-settings-page.html" > < abbr title = "src/admin/layout/class-settings-page.php" > class-settings-page.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 >
< p class = "phpdocumentor-summary" > Returns an array of all registered sections for the sub-page.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > get_sections< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > array< string|int, array< string|int, mixed> > < / span > < / code >
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > see< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > < a href = "classes/footnotes-admin-layout-Engine.html#method_add_section" > < abbr title = "\footnotes\admin\layout\Engine::add_section()" > Engine::add_section()< / abbr > < / a > < / span >
< section class = "phpdocumentor-description" > < p > For more information on the section array format.< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 1.5.0< / span >
< / dd >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 2.1.6< / span >
< section class = "phpdocumentor-description" > < p > Remove conditional rendering of ‘ ’ < / p >
< / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > array< string|int, array< string|int, mixed> > < / span >
—
< section class = "phpdocumentor-description" > < p > All of the registered sections.< / p >
< / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_get_sub_page_slug" >
get_sub_page_slug()
< a href = "classes/footnotes-admin-layout-SettingsPage.html#method_get_sub_page_slug" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/admin/layout/class-settings-page.php" > < a href = "files/src-admin-layout-class-settings-page.html" > < abbr title = "src/admin/layout/class-settings-page.php" > class-settings-page.php< / abbr > < / a > < / abbr >
:
2021-08-09 10:49:15 +00:00
< span class = "phpdocumentor-element-found-in__line" > 234< / span >
2021-08-09 10:27:33 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Returns the unique slug of the sub-page.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > get_sub_page_slug< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > string< / span > < / code >
< 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" > string< / span >
—
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_get_sub_page_title" >
get_sub_page_title()
< a href = "classes/footnotes-admin-layout-SettingsPage.html#method_get_sub_page_title" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/admin/layout/class-settings-page.php" > < a href = "files/src-admin-layout-class-settings-page.html" > < abbr title = "src/admin/layout/class-settings-page.php" > class-settings-page.php< / abbr > < / a > < / abbr >
:
2021-08-09 10:49:15 +00:00
< span class = "phpdocumentor-element-found-in__line" > 243< / span >
2021-08-09 10:27:33 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Returns the title of the sub-page.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > get_sub_page_title< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > string< / span > < / code >
< 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" > string< / span >
—
< / 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 >
< p class = "phpdocumentor-summary" > Loads a specified setting.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > load_setting< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $setting_key_name< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > array< string|int, mixed> < / span > < / code >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $setting_key_name< / span >
: < 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 >
< / 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< string|int, mixed> < / span >
—
< 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 >
< p class = "phpdocumentor-summary" > Append JavaScript and CSS files for specific sub-page.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > private< / span >
< span class = "phpdocumentor-signature__name" > append_scripts< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > 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" > 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 >
< / 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 >
< span class = "phpdocumentor-signature__response_type" > void< / span >
—
< / 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 >
< p class = "phpdocumentor-summary" > Registers all Meta boxes for a sub-page.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > private< / span >
< span class = "phpdocumentor-signature__name" > register_meta_boxes< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $parent_id< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > void< / span > < / code >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $parent_id< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > Parent section unique ID.< / p >
< / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > 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 >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > void< / span >
—
< / article >
< article
class="phpdocumentor-element
-method
-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-08-09 10:27:33 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Save plugin settings.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > private< / span >
< span class = "phpdocumentor-signature__name" > save_settings< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > bool< / span > < / code >
< 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 >
< / 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 >
< 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 >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > bool< / span >
—
< section class = "phpdocumentor-description" > < p > < code class = "prettyprint" > true< / code > on save success, else < code class = "prettyprint" > false< / code > .< / p >
< / section >
< / article >
< / section >
< script type = "text/javascript" >
function loadExternalCodeSnippets(line) {
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
var src = pre.getAttribute('data-src').replace( /\\/g, '/');
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
var language = 'php';
var code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
if (xhr.status < 400 & & xhr . responseText ) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
}
else if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
}
else {
code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
}
}
};
xhr.send(null);
});
}
var modals = document.querySelectorAll("[data-modal]");
modals.forEach(function (trigger) {
trigger.addEventListener("click", function (event) {
//event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippets(trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
< / script >
< / article >
< section data-search-results class = "phpdocumentor-search-results phpdocumentor-search-results--hidden" >
< section class = "phpdocumentor-search-results__dialog" >
< header class = "phpdocumentor-search-results__header" >
< h2 class = "phpdocumentor-search-results__title" > Search results< / h2 >
< button class = "phpdocumentor-search-results__close" > < i class = "fas fa-times" > < / i > < / button >
< / header >
< section class = "phpdocumentor-search-results__body" >
< ul class = "phpdocumentor-search-results__entries" > < / ul >
< / section >
< / section >
< / section >
< / div >
< / div >
< a href = "classes/footnotes-admin-layout-SettingsPage.html#top" class = "phpdocumentor-back-to-top" > < i class = "fas fa-chevron-circle-up" > < / i > < / a >
< / main >
< script >
cssVars({});
< / script >
< script src = "https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js" > < / script >
< script src = "https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js" > < / script >
< script src = "https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js" > < / script >
< script src = "https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js" > < / script >
< / body >
< / html >
