2021-05-01 20:39:33 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > Documentation< / title >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< base href = "../" >
< link rel = "icon" href = "images/favicon.ico" / >
< link rel = "stylesheet" href = "css/normalize.css" >
< link rel = "stylesheet" href = "css/base.css" >
2021-08-09 10:27:33 +00:00
< link rel = "preconnect" href = "https://fonts.gstatic.com" >
< link href = "https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel = "stylesheet" >
< link href = "https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel = "stylesheet" >
2021-05-01 20:39:33 +00:00
< link rel = "stylesheet" href = "css/template.css" >
< link rel = "stylesheet" href = "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity = "sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin = "anonymous" / >
2021-08-09 10:27:33 +00:00
< link rel = "stylesheet" href = "https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css" >
< link rel = "stylesheet" href = "https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css" >
< link rel = "stylesheet" href = "https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css" >
2021-05-01 20:39:33 +00:00
< script src = "https://cdn.jsdelivr.net/npm/fuse.js@3.4.6" > < / script >
< script src = "https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2" > < / script >
< script src = "js/search.js" > < / script >
< script defer src = "js/searchIndex.js" > < / script >
< / head >
< body id = "top" >
< header class = "phpdocumentor-header phpdocumentor-section" >
< h1 class = "phpdocumentor-title" > < a href = "" class = "phpdocumentor-title__link" > Documentation< / a > < / h1 >
< input class = "phpdocumentor-header__menu-button" type = "checkbox" id = "menu-button" name = "menu-button" / >
< label class = "phpdocumentor-header__menu-icon" for = "menu-button" >
< i class = "fas fa-bars" > < / i >
< / label >
< section data-search-form class = "phpdocumentor-search" >
< label >
< span class = "visually-hidden" > Search for< / span >
< svg class = "phpdocumentor-search__icon" width = "21" height = "20" viewBox = "0 0 21 20" fill = "none" xmlns = "http://www.w3.org/2000/svg" >
< circle cx = "7.5" cy = "7.5" r = "6.5" stroke = "currentColor" stroke-width = "2" / >
< line x1 = "12.4892" y1 = "12.2727" x2 = "19.1559" y2 = "18.9393" stroke = "currentColor" stroke-width = "3" / >
< / svg >
< input type = "search" class = "phpdocumentor-field phpdocumentor-search__field" placeholder = "Loading .." disabled / >
< / label >
< / section >
< nav class = "phpdocumentor-topnav" >
< ul class = "phpdocumentor-topnav__menu" >
< / ul >
< / nav >
< / header >
< main class = "phpdocumentor" >
< div class = "phpdocumentor-section" >
< input class = "phpdocumentor-sidebar__menu-button" type = "checkbox" id = "sidebar-button" name = "sidebar-button" / >
< label class = "phpdocumentor-sidebar__menu-icon" for = "sidebar-button" >
Menu
< / label >
< aside class = "phpdocumentor-column -four phpdocumentor-sidebar" >
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
< section class = "phpdocumentor-sidebar__category" >
< h2 class = "phpdocumentor-sidebar__category-header" > Namespaces< / h2 >
2021-08-09 10:27:33 +00:00
< h3 class = "phpdocumentor-sidebar__root-namespace" > < a href = "namespaces/default.html" > < abbr title = "\" > Global< / abbr > < / a > < / h3 >
< h4 class = "phpdocumentor-sidebar__root-namespace" > < a href = "namespaces/footnotes.html" > < abbr title = "\footnotes" > footnotes< / abbr > < / a > < / h4 >
2021-05-01 20:39:33 +00:00
< ul class = "phpdocumentor-list" >
< li > < a href = "namespaces/footnotes-admin.html" > < abbr title = "\footnotes\admin" > admin< / abbr > < / a > < / li >
< li > < a href = "namespaces/footnotes-includes.html" > < abbr title = "\footnotes\includes" > includes< / abbr > < / a > < / li >
< li > < a href = "namespaces/footnotes-general.html" > < abbr title = "\footnotes\general" > general< / abbr > < / a > < / li >
< / ul >
< / section >
2021-05-02 20:27:53 +00:00
< section class = "phpdocumentor-sidebar__category" >
< h2 class = "phpdocumentor-sidebar__category-header" > Packages< / h2 >
2021-08-09 10:27:33 +00:00
< h3 class = "phpdocumentor-sidebar__root-package" > < a href = "packages/footnotes.html" > < abbr title = "\footnotes" > footnotes< / abbr > < / a > < / h3 >
2021-05-02 20:27:53 +00:00
< ul class = "phpdocumentor-list" >
< li > < a href = "packages/footnotes-includes.html" > < abbr title = "\footnotes\includes" > includes< / abbr > < / a > < / li >
< / ul >
< / section >
2021-05-01 20:39:33 +00:00
< section class = "phpdocumentor-sidebar__category" >
< h2 class = "phpdocumentor-sidebar__category-header" > Reports< / h2 >
< h3 class = "phpdocumentor-sidebar__root-package" > < a href = "reports/deprecated.html" > Deprecated< / a > < / h3 >
< h3 class = "phpdocumentor-sidebar__root-package" > < a href = "reports/errors.html" > Errors< / a > < / h3 >
< h3 class = "phpdocumentor-sidebar__root-package" > < a href = "reports/markers.html" > Markers< / a > < / h3 >
< / section >
< section class = "phpdocumentor-sidebar__category" >
< h2 class = "phpdocumentor-sidebar__category-header" > Indices< / h2 >
< h3 class = "phpdocumentor-sidebar__root-package" > < a href = "indices/files.html" > Files< / a > < / h3 >
< / section >
< / aside >
< div class = "phpdocumentor-column -eight phpdocumentor-content" >
< ul class = "phpdocumentor-breadcrumbs" >
< li class = "phpdocumentor-breadcrumb" > < a href = "namespaces/footnotes.html" > footnotes< / a > < / li >
< li class = "phpdocumentor-breadcrumb" > < a href = "namespaces/footnotes-includes.html" > includes< / a > < / li >
< / ul >
< article class = "phpdocumentor-element -class" >
< h2 class = "phpdocumentor-content__title" >
Settings
2021-05-02 20:27:53 +00:00
< div class = "phpdocumentor-element__package" >
in package
< ul class = "phpdocumentor-breadcrumbs" >
< li class = "phpdocumentor-breadcrumb" > < a href = "packages/footnotes.html" > footnotes< / a > < / li >
< / ul >
< / div >
2021-05-01 20:39:33 +00:00
< / h2 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/includes/class-settings.php" > < a href = "files/src-includes-class-settings.html" > < abbr title = "src/includes/class-settings.php" > class-settings.php< / abbr > < / a > < / abbr >
:
2021-08-09 10:27:33 +00:00
< span class = "phpdocumentor-element-found-in__line" > 31< / span >
< / aside >
2021-05-01 20:39:33 +00:00
< p class = "phpdocumentor-summary" > Class defining configurable plugin settings.< / p >
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 1.5.0< / span >
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
< / dd >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 2.8.0< / span >
< section class = "phpdocumentor-description" > < p > Renamed class from < code class = "prettyprint" > Footnotes_Settings< / code > to < code class = "prettyprint" > Settings< / code > .
Moved under < code class = "prettyprint" > footnotes\includes< / code > namespace.< / p >
< / section >
< / dd >
< / dl >
< h3 id = "toc" >
Table of Contents
< a href = "#toc" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h3 >
< dl class = "phpdocumentor-table-of-contents" >
2021-08-09 10:27:33 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -property -public" >
< a href = "classes/footnotes-includes-Settings.html#property_settings_sections" > $settings_sections< / a >
2021-05-01 20:39:33 +00:00
< span >
2021-08-09 10:27:33 +00:00
: array< string|int, < abbr title = "\footnotes\includes\SettingsSection" > SettingsSection< / abbr > > < / span >
2021-05-01 20:39:33 +00:00
< / dt >
2021-08-09 10:27:33 +00:00
< dd > Contains each section of settings.< / dd >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -property -private" >
< a href = "classes/footnotes-includes-Settings.html#property_options_group_slugs" > $options_group_slugs< / a >
2021-05-01 20:39:33 +00:00
< span >
2021-08-09 10:27:33 +00:00
: array< string|int, mixed> < / span >
2021-05-01 20:39:33 +00:00
< / dt >
2021-08-09 10:27:33 +00:00
< dd > Contains all Settings option group slugs.< / dd >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/footnotes-includes-Settings.html#method___construct" > __construct()< / a >
2021-05-01 20:39:33 +00:00
< span >
2021-08-09 10:27:33 +00:00
: mixed < / span >
2021-05-01 20:39:33 +00:00
< / dt >
2021-08-09 10:27:33 +00:00
< dd > Loads all Settings from each WordPress Settings Container.< / dd >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/footnotes-includes-Settings.html#method_get_options_group_slug" > get_options_group_slug()< / a >
2021-05-01 20:39:33 +00:00
< span >
2021-08-09 10:27:33 +00:00
: string < / span >
2021-05-01 20:39:33 +00:00
< / dt >
2021-08-09 10:27:33 +00:00
< dd > Returns the name of a specified Settings Container.< / dd >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/footnotes-includes-Settings.html#method_get_setting" > get_setting()< / a >
2021-05-01 20:39:33 +00:00
< span >
2021-08-09 10:27:33 +00:00
: < a href = "classes/footnotes-includes-settings-Setting.html" > < abbr title = "\footnotes\includes\settings\Setting" > Setting< / abbr > < / a > |null < / span >
2021-05-01 20:39:33 +00:00
< / dt >
2021-08-09 10:27:33 +00:00
< dd > Retrieve a setting by its key.< / dd >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/footnotes-includes-Settings.html#method_get_setting_default_value" > get_setting_default_value()< / a >
2021-05-01 20:39:33 +00:00
< span >
2021-08-09 10:27:33 +00:00
: mixed < / span >
2021-05-01 20:39:33 +00:00
< / dt >
2021-08-09 10:27:33 +00:00
< dd > Retrieve a setting' s default value by its key.< / dd >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/footnotes-includes-Settings.html#method_get_setting_value" > get_setting_value()< / a >
2021-05-01 20:39:33 +00:00
< span >
2021-08-09 10:27:33 +00:00
: mixed < / span >
2021-05-01 20:39:33 +00:00
< / dt >
2021-08-09 10:27:33 +00:00
< dd > Retrieve a setting' s value by its key.< / dd >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/footnotes-includes-Settings.html#method_save_options_group" > save_options_group()< / a >
2021-05-01 20:39:33 +00:00
< span >
2021-08-09 10:27:33 +00:00
: bool < / span >
2021-05-01 20:39:33 +00:00
< / dt >
2021-08-09 10:27:33 +00:00
< dd > Updates a whole Setting Container on save.< / dd >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/footnotes-includes-Settings.html#method_set_setting_value" > set_setting_value()< / a >
2021-05-01 20:39:33 +00:00
< span >
2021-08-09 10:27:33 +00:00
: mixed < / span >
2021-05-01 20:39:33 +00:00
< / dt >
2021-08-09 10:27:33 +00:00
< dd > Set a setting' s value by its key.< / dd >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/footnotes-includes-Settings.html#method_load_dependencies" > load_dependencies()< / a >
2021-05-01 20:39:33 +00:00
< span >
2021-08-09 10:27:33 +00:00
: void < / span >
2021-05-01 20:39:33 +00:00
< / dt >
2021-08-09 10:27:33 +00:00
< dd > Load the required dependencies for this file.< / dd >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/footnotes-includes-Settings.html#method_load_options_groups" > load_options_groups()< / a >
2021-05-02 20:27:53 +00:00
< span >
2021-08-09 10:27:33 +00:00
: void < / span >
2021-05-02 20:27:53 +00:00
< / dt >
2021-08-09 10:27:33 +00:00
< dd > Loads all settings from each option group.< / dd >
2021-05-02 20:27:53 +00:00
2021-08-09 10:27:33 +00:00
< / dl >
2021-05-02 20:27:53 +00:00
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
< section class = "phpdocumentor-properties" >
< h3 class = "phpdocumentor-elements__header" id = "properties" >
Properties
< a href = "classes/footnotes-includes-Settings.html#properties" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
2021-08-09 10:27:33 +00:00
< / h3 >
2021-05-01 20:39:33 +00:00
< article
class="
phpdocumentor-element
-property
2021-08-09 10:27:33 +00:00
-public
"
2021-05-01 20:39:33 +00:00
>
2021-08-09 10:27:33 +00:00
< h4 class = "phpdocumentor-element__name" id = "property_settings_sections" >
$settings_sections
< a href = "classes/footnotes-includes-Settings.html#property_settings_sections" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
2021-05-01 20:39:33 +00:00
< span class = "phpdocumentor-element__modifiers" >
< / span >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/includes/class-settings.php" > < a href = "files/src-includes-class-settings.html" > < abbr title = "src/includes/class-settings.php" > class-settings.php< / abbr > < / a > < / abbr >
:
2021-08-09 10:27:33 +00:00
< span class = "phpdocumentor-element-found-in__line" > 57< / span >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< / aside >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< p class = "phpdocumentor-summary" > Contains each section of settings.< / p >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__type" > array< string|int, < abbr title = "\footnotes\includes\SettingsSection" > SettingsSection< / abbr > > < / span >
< span class = "phpdocumentor-signature__name" > $settings_sections< / span >
= < span class = "phpdocumentor-signature__default-value" > array()< / span > < / code >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
2021-08-09 10:27:33 +00:00
< span class = "phpdocumentor-tag-link" > 2.8.0< / span >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
< / dd >
< / dl >
< / article >
< article
class="
phpdocumentor-element
-property
-private
2021-05-02 20:27:53 +00:00
"
2021-05-01 20:39:33 +00:00
>
2021-08-09 10:27:33 +00:00
< h4 class = "phpdocumentor-element__name" id = "property_options_group_slugs" >
$options_group_slugs
< a href = "classes/footnotes-includes-Settings.html#property_options_group_slugs" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
2021-05-01 20:39:33 +00:00
< span class = "phpdocumentor-element__modifiers" >
< / span >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/includes/class-settings.php" > < a href = "files/src-includes-class-settings.html" > < abbr title = "src/includes/class-settings.php" > class-settings.php< / abbr > < / a > < / abbr >
:
2021-08-09 10:27:33 +00:00
< span class = "phpdocumentor-element-found-in__line" > 43< / span >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Contains all Settings option group slugs.< / p >
2021-05-01 20:39:33 +00:00
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > private< / span >
2021-05-02 20:27:53 +00:00
< span class = "phpdocumentor-signature__type" > array< string|int, mixed> < / span >
2021-08-09 10:27:33 +00:00
< span class = "phpdocumentor-signature__name" > $options_group_slugs< / span >
= < span class = "phpdocumentor-signature__default-value" > array(' footnotes_storage' , ' footnotes_storage_custom' , ' footnotes_storage_expert' , ' footnotes_storage_custom_css' )< / span > < / code >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< section class = "phpdocumentor-description" > < p > Each option group relates to a single tab on the admin. dashboard.< / p >
< / section >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 1.5.0< / span >
2021-08-09 10:27:33 +00:00
2021-05-02 20:27:53 +00:00
< / dd >
2021-08-09 10:27:33 +00:00
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
2021-05-02 20:27:53 +00:00
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
2021-08-09 10:27:33 +00:00
< span class = "phpdocumentor-tag-link" > 2.8.0< / span >
2021-05-02 20:27:53 +00:00
2021-08-09 10:27:33 +00:00
< section class = "phpdocumentor-description" > < p > Renamed from < code class = "prettyprint" > container< / code > to < code class = "prettyprint" > options_group_slugs< / code > .< / p >
2021-05-02 20:27:53 +00:00
< / section >
2021-05-01 20:39:33 +00:00
< / dd >
< / dl >
< / article >
< / section >
< section class = "phpdocumentor-methods" >
< h3 class = "phpdocumentor-elements__header" id = "methods" >
Methods
< a href = "classes/footnotes-includes-Settings.html#methods" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h3 >
< article
class="phpdocumentor-element
-method
-public
"
>
2021-08-09 10:27:33 +00:00
< h4 class = "phpdocumentor-element__name" id = "method___construct" >
__construct()
< a href = "classes/footnotes-includes-Settings.html#method___construct" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
2021-05-01 20:39:33 +00:00
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/includes/class-settings.php" > < a href = "files/src-includes-class-settings.html" > < abbr title = "src/includes/class-settings.php" > class-settings.php< / abbr > < / a > < / abbr >
:
2021-08-09 10:27:33 +00:00
< span class = "phpdocumentor-element-found-in__line" > 64< / span >
< / aside >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< p class = "phpdocumentor-summary" > Loads all Settings from each WordPress Settings Container.< / p >
2021-05-01 20:39:33 +00:00
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
2021-08-09 10:27:33 +00:00
< span class = "phpdocumentor-signature__name" > __construct< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > mixed< / span > < / code >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 1.5.0< / span >
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
2021-08-09 10:27:33 +00:00
< span class = "phpdocumentor-signature__response_type" > mixed< / span >
2021-05-01 20:39:33 +00:00
—
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
2021-08-09 10:27:33 +00:00
< h4 class = "phpdocumentor-element__name" id = "method_get_options_group_slug" >
get_options_group_slug()
< a href = "classes/footnotes-includes-Settings.html#method_get_options_group_slug" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
2021-05-01 20:39:33 +00:00
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/includes/class-settings.php" > < a href = "files/src-includes-class-settings.html" > < abbr title = "src/includes/class-settings.php" > class-settings.php< / abbr > < / a > < / abbr >
:
2021-08-09 10:49:15 +00:00
< span class = "phpdocumentor-element-found-in__line" > 206< / span >
2021-08-09 10:27:33 +00:00
< / aside >
2021-05-01 20:39:33 +00:00
< p class = "phpdocumentor-summary" > Returns the name of a specified Settings Container.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
2021-08-09 10:27:33 +00:00
< span class = "phpdocumentor-signature__name" > get_options_group_slug< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > int < / span > < span class = "phpdocumentor-signature__argument__name" > $index< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > string< / span > < / code >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
2021-05-02 20:27:53 +00:00
< span class = "phpdocumentor-signature__argument__name" > $index< / span >
2021-05-01 20:39:33 +00:00
: < span class = "phpdocumentor-signature__argument__return-type" > int< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
2021-08-09 10:27:33 +00:00
< section class = "phpdocumentor-description" > < p > Options group index.< / p >
2021-05-01 20:39:33 +00:00
< / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 1.5.0< / span >
2021-08-09 10:27:33 +00:00
< / dd >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 2.8.0< / span >
< section class = "phpdocumentor-description" > < p > Renamed from < code class = "prettyprint" > get_container()< / code > to < code class = "prettyprint" > get_options_group_slug()< / code > .< / p >
< / section >
2021-05-01 20:39:33 +00:00
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
2021-05-02 20:27:53 +00:00
< span class = "phpdocumentor-signature__response_type" > string< / span >
2021-05-01 20:39:33 +00:00
—
2021-08-09 10:27:33 +00:00
< section class = "phpdocumentor-description" > < p > Options group slug name.< / p >
2021-05-01 20:39:33 +00:00
< / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
2021-08-09 10:27:33 +00:00
< h4 class = "phpdocumentor-element__name" id = "method_get_setting" >
get_setting()
< a href = "classes/footnotes-includes-Settings.html#method_get_setting" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
2021-05-01 20:39:33 +00:00
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/includes/class-settings.php" > < a href = "files/src-includes-class-settings.html" > < abbr title = "src/includes/class-settings.php" > class-settings.php< / abbr > < / a > < / abbr >
:
2021-08-09 10:27:33 +00:00
< span class = "phpdocumentor-element-found-in__line" > 115< / span >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Retrieve a setting by its key.< / p >
2021-05-01 20:39:33 +00:00
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
2021-08-09 10:27:33 +00:00
< span class = "phpdocumentor-signature__name" > get_setting< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $setting_key< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > < a href = "classes/footnotes-includes-settings-Setting.html" > < abbr title = "\footnotes\includes\settings\Setting" > Setting< / abbr > < / a > |null< / span > < / code >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
2021-08-09 10:27:33 +00:00
< span class = "phpdocumentor-signature__argument__name" > $setting_key< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
2021-05-01 20:39:33 +00:00
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
2021-08-09 10:27:33 +00:00
< section class = "phpdocumentor-description" > < p > The key of the setting to search for.< / p >
2021-05-01 20:39:33 +00:00
< / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
2021-08-09 10:27:33 +00:00
< span class = "phpdocumentor-tag-link" > 2.8.0< / span >
< / dd >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > todo< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< section class = "phpdocumentor-description" > < p > This is an < em > O(n)< / em > linear search. Explore more scaleable alternatives.< / p >
< / section >
2021-05-01 20:39:33 +00:00
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
2021-08-09 10:27:33 +00:00
< span class = "phpdocumentor-signature__response_type" > < a href = "classes/footnotes-includes-settings-Setting.html" > < abbr title = "\footnotes\includes\settings\Setting" > Setting< / abbr > < / a > |null< / span >
2021-05-01 20:39:33 +00:00
—
2021-08-09 10:27:33 +00:00
< section class = "phpdocumentor-description" > < p > Either the setting object, or < code class = "prettyprint" > null< / code > if none exists.< / p >
2021-05-01 20:39:33 +00:00
< / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
2021-08-09 10:27:33 +00:00
"
2021-05-01 20:39:33 +00:00
>
2021-08-09 10:27:33 +00:00
< h4 class = "phpdocumentor-element__name" id = "method_get_setting_default_value" >
get_setting_default_value()
< a href = "classes/footnotes-includes-Settings.html#method_get_setting_default_value" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
2021-05-01 20:39:33 +00:00
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/includes/class-settings.php" > < a href = "files/src-includes-class-settings.html" > < abbr title = "src/includes/class-settings.php" > class-settings.php< / abbr > < / a > < / abbr >
:
2021-08-09 10:49:15 +00:00
< span class = "phpdocumentor-element-found-in__line" > 161< / span >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Retrieve a setting' s default value by its key.< / p >
2021-05-01 20:39:33 +00:00
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
2021-08-09 10:27:33 +00:00
< span class = "phpdocumentor-signature__name" > get_setting_default_value< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $setting_key< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > mixed< / span > < / code >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $setting_key< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > The key of the setting to search for.< / p >
< / section >
< / dd >
< / dl >
2021-05-01 20:39:33 +00:00
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
2021-08-09 10:27:33 +00:00
< span class = "phpdocumentor-tag-link" > 2.8.0< / span >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
< / dd >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > todo< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
2021-08-09 10:27:33 +00:00
< section class = "phpdocumentor-description" > < p > This is an < em > O(n)< / em > linear search. Explore more scaleable alternatives.< / 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 > How to handle settings with a default value of < code class = "prettyprint" > null< / code > ?< / p >
2021-05-01 20:39:33 +00:00
< / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
2021-08-09 10:27:33 +00:00
< span class = "phpdocumentor-signature__response_type" > mixed< / span >
2021-05-01 20:39:33 +00:00
—
2021-08-09 10:27:33 +00:00
< section class = "phpdocumentor-description" > < p > Either the setting's default value, or < code class = "prettyprint" > null< / code > if the setting does not exist.< / p >
< / section >
2021-05-01 20:39:33 +00:00
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
2021-08-09 10:27:33 +00:00
< h4 class = "phpdocumentor-element__name" id = "method_get_setting_value" >
get_setting_value()
< a href = "classes/footnotes-includes-Settings.html#method_get_setting_value" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
2021-05-01 20:39:33 +00:00
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/includes/class-settings.php" > < a href = "files/src-includes-class-settings.html" > < abbr title = "src/includes/class-settings.php" > class-settings.php< / abbr > < / a > < / abbr >
:
2021-08-09 10:49:15 +00:00
< span class = "phpdocumentor-element-found-in__line" > 138< / span >
2021-08-09 10:27:33 +00:00
< / aside >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< p class = "phpdocumentor-summary" > Retrieve a setting' s value by its key.< / p >
2021-05-01 20:39:33 +00:00
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
2021-08-09 10:27:33 +00:00
< span class = "phpdocumentor-signature__name" > get_setting_value< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $setting_key< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > mixed< / span > < / code >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $setting_key< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > The key of the setting to search for.< / p >
2021-05-01 20:39:33 +00:00
< / section >
2021-08-09 10:27:33 +00:00
< / dd >
< / dl >
2021-05-01 20:39:33 +00:00
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
2021-08-09 10:27:33 +00:00
< span class = "phpdocumentor-tag-link" > 2.8.0< / span >
< / dd >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > todo< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< section class = "phpdocumentor-description" > < p > This is an < em > O(n)< / em > linear search. Explore more scaleable alternatives.< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > todo< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< section class = "phpdocumentor-description" > < p > How to handle settings with a value of < code class = "prettyprint" > null< / code > ?< / p >
< / section >
2021-05-01 20:39:33 +00:00
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
2021-08-09 10:27:33 +00:00
< span class = "phpdocumentor-signature__response_type" > mixed< / span >
2021-05-01 20:39:33 +00:00
—
2021-08-09 10:27:33 +00:00
< section class = "phpdocumentor-description" > < p > Either the setting's value, or < code class = "prettyprint" > null< / code > if the setting does not exist.< / p >
< / section >
2021-05-01 20:39:33 +00:00
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
2021-08-09 10:27:33 +00:00
< h4 class = "phpdocumentor-element__name" id = "method_save_options_group" >
save_options_group()
< a href = "classes/footnotes-includes-Settings.html#method_save_options_group" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
2021-05-01 20:39:33 +00:00
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/includes/class-settings.php" > < a href = "files/src-includes-class-settings.html" > < abbr title = "src/includes/class-settings.php" > class-settings.php< / abbr > < / a > < / abbr >
:
2021-08-09 10:49:15 +00:00
< span class = "phpdocumentor-element-found-in__line" > 219< / span >
2021-08-09 10:27:33 +00:00
< / aside >
2021-05-01 20:39:33 +00:00
< p class = "phpdocumentor-summary" > Updates a whole Setting Container on save.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
2021-08-09 10:27:33 +00:00
< span class = "phpdocumentor-signature__name" > save_options_group< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $options_group_slug< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > array< string|int, mixed> < / span > < span class = "phpdocumentor-signature__argument__name" > $new_values< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > bool< / span > < / code >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
2021-08-09 10:27:33 +00:00
< span class = "phpdocumentor-signature__argument__name" > $options_group_slug< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
2021-05-01 20:39:33 +00:00
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
2021-08-09 10:27:33 +00:00
< section class = "phpdocumentor-description" > < p > Options group slug to save.< / p >
2021-05-01 20:39:33 +00:00
< / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
2021-05-02 20:27:53 +00:00
< span class = "phpdocumentor-signature__argument__name" > $new_values< / span >
2021-05-01 20:39:33 +00:00
: < span class = "phpdocumentor-signature__argument__return-type" > array< string|int, mixed> < / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > The new Settings value(s).< / p >
< / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 1.5.0< / span >
2021-08-09 10:27:33 +00:00
< / dd >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 2.8.0< / span >
< section class = "phpdocumentor-description" > < p > Change first parameter type from < code class = "prettyprint" > int< / code > to < code class = "prettyprint" > string< / code > .< / p >
< / section >
2021-05-01 20:39:33 +00:00
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > bool< / span >
—
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
< / article >
< article
class="phpdocumentor-element
-method
2021-08-09 10:27:33 +00:00
-public
2021-05-01 20:39:33 +00:00
"
>
2021-08-09 10:27:33 +00:00
< h4 class = "phpdocumentor-element__name" id = "method_set_setting_value" >
set_setting_value()
< a href = "classes/footnotes-includes-Settings.html#method_set_setting_value" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
2021-05-01 20:39:33 +00:00
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/includes/class-settings.php" > < a href = "files/src-includes-class-settings.html" > < abbr title = "src/includes/class-settings.php" > class-settings.php< / abbr > < / a > < / abbr >
:
2021-08-09 10:49:15 +00:00
< span class = "phpdocumentor-element-found-in__line" > 185< / span >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< / aside >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< p class = "phpdocumentor-summary" > Set a setting' s value by its key.< / p >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__name" > set_setting_value< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $setting_key< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > mixed < / span > < span class = "phpdocumentor-signature__argument__name" > $setting_value< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > mixed< / span > < / code >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $setting_key< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > The key of the setting to search for.< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $setting_value< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > mixed< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > The new value to set.< / p >
< / section >
< / dd >
< / dl >
2021-05-01 20:39:33 +00:00
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
2021-08-09 10:27:33 +00:00
< span class = "phpdocumentor-tag-link" > 2.8.0< / span >
< / dd >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > todo< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< section class = "phpdocumentor-description" > < p > This is an < em > O(n)< / em > linear search. Explore more scaleable alternatives.< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > todo< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< section class = "phpdocumentor-description" > < p > How to handle settings with a value of < code class = "prettyprint" > null< / code > ?< / p >
< / section >
2021-05-01 20:39:33 +00:00
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > mixed< / span >
—
2021-08-09 10:27:33 +00:00
< section class = "phpdocumentor-description" > < p > 'True' if the value was successfully set. 'False' otherwise.< / p >
< / section >
2021-05-01 20:39:33 +00:00
< / article >
< article
class="phpdocumentor-element
-method
2021-08-09 10:27:33 +00:00
-protected
2021-05-01 20:39:33 +00:00
"
>
2021-08-09 10:27:33 +00:00
< h4 class = "phpdocumentor-element__name" id = "method_load_dependencies" >
load_dependencies()
< a href = "classes/footnotes-includes-Settings.html#method_load_dependencies" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
2021-05-01 20:39:33 +00:00
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/includes/class-settings.php" > < a href = "files/src-includes-class-settings.html" > < abbr title = "src/includes/class-settings.php" > class-settings.php< / abbr > < / a > < / abbr >
:
2021-08-09 10:27:33 +00:00
< span class = "phpdocumentor-element-found-in__line" > 94< / span >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< / aside >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< p class = "phpdocumentor-summary" > Load the required dependencies for this file.< / p >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > load_dependencies< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > void< / span > < / code >
< section class = "phpdocumentor-description" > < p > Includes the following files that make up the plugin:< / p >
< ul >
< li >
< abbr title = "\footnotes\includes\SettingsSection" > SettingsSection< / abbr > : defines a section of settings groups;< / li >
< li >
< abbr title = "\footnotes\includes\SettingsGroup" > SettingsGroup< / abbr > : defines a group of settings;< / li >
< li >
< a href = "classes/footnotes-includes-settings-Setting.html" > < abbr title = "\footnotes\includes\settings\Setting" > Setting< / abbr > < / a > : defines a single setting;< / li >
< li >
< a href = "classes/footnotes-includes-settings-general-GeneralSettingsSection.html" > < abbr title = "\footnotes\includes\settings\general\GeneralSettingsSection" > GeneralSettingsSection< / abbr > < / a > : provides general plugin settings;< / li >
< li >
< a href = "classes/footnotes-includes-settings-referrersandtooltips-ReferrersAndTooltipsSettingsSection.html" > < abbr title = "\footnotes\includes\settings\referrersandtooltips\ReferrersAndTooltipsSettingsSection" > ReferrersAndTooltipsSettingsSection< / abbr > < / a > : provides settings for
customising the plugin's created referrers and tooltips;< / li >
< li >
< a href = "classes/footnotes-includes-settings-scopeandpriority-ScopeAndPrioritySettingsSection.html" > < abbr title = "\footnotes\includes\settings\scopeandpriority\ScopeAndPrioritySettingsSection" > ScopeAndPrioritySettingsSection< / abbr > < / a > : defines plugin scope and priority
settings; and< / li >
< li >
< a href = "classes/footnotes-includes-settings-customcss-CustomCSSSettingsSection.html" > < abbr title = "\footnotes\includes\settings\customcss\CustomCSSSettingsSection" > CustomCSSSettingsSection< / abbr > < / a > : provides custom CSS settings.< / li >
< / ul >
2021-05-01 20:39:33 +00:00
< / section >
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
2021-08-09 10:27:33 +00:00
< span class = "phpdocumentor-tag-link" > 2.8.0< / span >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
2021-08-09 10:27:33 +00:00
< span class = "phpdocumentor-signature__response_type" > void< / span >
2021-05-01 20:39:33 +00:00
—
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
< / article >
< article
class="phpdocumentor-element
-method
2021-08-09 10:27:33 +00:00
-protected
2021-05-01 20:39:33 +00:00
"
>
2021-08-09 10:27:33 +00:00
< h4 class = "phpdocumentor-element__name" id = "method_load_options_groups" >
load_options_groups()
< a href = "classes/footnotes-includes-Settings.html#method_load_options_groups" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
2021-05-01 20:39:33 +00:00
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/includes/class-settings.php" > < a href = "files/src-includes-class-settings.html" > < abbr title = "src/includes/class-settings.php" > class-settings.php< / abbr > < / a > < / abbr >
:
2021-08-09 10:49:15 +00:00
< span class = "phpdocumentor-element-found-in__line" > 237< / span >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< / aside >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< p class = "phpdocumentor-summary" > Loads all settings from each option group.< / p >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > load_options_groups< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > void< / span > < / code >
2021-05-01 20:39:33 +00:00
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 1.5.0< / span >
2021-08-09 10:27:33 +00:00
< / 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 > Renamed from < code class = "prettyprint" > load_all()< / code > to < code class = "prettyprint" > load_options_groups()< / code > .< / p >
< / section >
2021-05-01 20:39:33 +00:00
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
2021-05-02 20:27:53 +00:00
< span class = "phpdocumentor-signature__response_type" > void< / span >
2021-05-01 20:39:33 +00:00
—
2021-08-09 10:27:33 +00:00
2021-05-01 20:39:33 +00:00
< / article >
< / section >
2021-08-09 10:27:33 +00:00
< script type = "text/javascript" >
function loadExternalCodeSnippets(line) {
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
var src = pre.getAttribute('data-src').replace( /\\/g, '/');
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
var language = 'php';
var code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
if (xhr.status < 400 & & xhr . responseText ) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
}
else if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
}
else {
code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
}
}
};
xhr.send(null);
});
}
var modals = document.querySelectorAll("[data-modal]");
modals.forEach(function (trigger) {
trigger.addEventListener("click", function (event) {
//event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippets(trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
< / script >
2021-05-01 20:39:33 +00:00
< / article >
< section data-search-results class = "phpdocumentor-search-results phpdocumentor-search-results--hidden" >
< section class = "phpdocumentor-search-results__dialog" >
< header class = "phpdocumentor-search-results__header" >
< h2 class = "phpdocumentor-search-results__title" > Search results< / h2 >
< button class = "phpdocumentor-search-results__close" > < i class = "fas fa-times" > < / i > < / button >
< / header >
< section class = "phpdocumentor-search-results__body" >
< ul class = "phpdocumentor-search-results__entries" > < / ul >
< / section >
< / section >
< / section >
< / div >
< / div >
< a href = "classes/footnotes-includes-Settings.html#top" class = "phpdocumentor-back-to-top" > < i class = "fas fa-chevron-circle-up" > < / i > < / a >
< / main >
< script >
cssVars({});
< / script >
2021-08-09 10:27:33 +00:00
< script src = "https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js" > < / script >
< script src = "https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js" > < / script >
< script src = "https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js" > < / script >
< script src = "https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js" > < / script >
2021-05-01 20:39:33 +00:00
< / body >
< / html >
