2021-08-09 11:27:33 +01: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-includes.html" > includes< / a > < / li >
< li class = "phpdocumentor-breadcrumb" > < a href = "namespaces/footnotes-includes-settings.html" > settings< / a > < / li >
< / ul >
< article class = "phpdocumentor-element -class" >
< h2 class = "phpdocumentor-content__title" >
Setting
< 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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 21< / span >
< / aside >
< p class = "phpdocumentor-summary" > Class defining a configurable plugin setting.< / 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" > 2.8.0< / 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 -constant -public" >
< a href = "classes/footnotes-includes-settings-Setting.html#constant_FONT_SIZE_UNIT_OPTIONS" > FONT_SIZE_UNIT_OPTIONS< / a >
< span >
= array(' em' => ' em' , ' rem' => ' rem' , ' px' => ' pixels' , ' pt' => ' points' , ' pc' => ' picas' , ' mm' => ' millimeters' , ' %' => ' per cent' ) < / span >
< / dt >
< dd > Options for the custom font size units (per cent is a ratio, not a unit).< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -constant -public" >
< a href = "classes/footnotes-includes-settings-Setting.html#constant_TEXT_ELEMENT_OPTIONS" > TEXT_ELEMENT_OPTIONS< / a >
< span >
= array(' p' => ' paragraph' , ' h2' => ' heading 2' , ' h3' => ' heading 3' , ' h4' => ' heading 4' , ' h5' => ' heading 5' , ' h6' => ' heading 6' ) < / span >
< / dt >
< dd > Options for the HTML text elements.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -constant -public" >
< a href = "classes/footnotes-includes-settings-Setting.html#constant_WIDTH_UNIT_OPTIONS" > WIDTH_UNIT_OPTIONS< / a >
< span >
= array(' %' => ' per cent' , ' px' => ' pixels' , ' rem' => ' root em' , ' em' => ' em' , ' vw' => ' viewport width' ) < / span >
< / dt >
< dd > Options for the custom width units (per cent is a ratio, not a unit).< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -property -public" >
< a href = "classes/footnotes-includes-settings-Setting.html#property_description" > $description< / a >
< span >
: string|null < / span >
< / dt >
< dd > Setting description.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -property -public" >
< a href = "classes/footnotes-includes-settings-Setting.html#property_key" > $key< / a >
< span >
: string < / span >
< / dt >
< dd > Setting slug.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -property -public" >
< a href = "classes/footnotes-includes-settings-Setting.html#property_name" > $name< / a >
< span >
: string < / span >
< / dt >
< dd > Setting name.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -property -protected" >
< a href = "classes/footnotes-includes-settings-Setting.html#property_value" > $value< / a >
< span >
: mixed < / span >
< / dt >
< dd > Setting value.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -property -private" >
< a href = "classes/footnotes-includes-settings-Setting.html#property_default_value" > $default_value< / a >
< span >
: mixed < / span >
< / dt >
< dd > Setting default value.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -property -private" >
< a href = "classes/footnotes-includes-settings-Setting.html#property_enabled_by" > $enabled_by< / a >
< span >
: string|null < / span >
< / dt >
< dd > The setting for whether this setting is enabled or not.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -property -private" >
< a href = "classes/footnotes-includes-settings-Setting.html#property_group_id" > $group_id< / a >
< span >
: string < / span >
< / dt >
< dd > Setting group ID.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -property -private" >
< a href = "classes/footnotes-includes-settings-Setting.html#property_input_max" > $input_max< / a >
< span >
: int|float|null < / span >
< / dt >
< dd > Setting input field max. value (for ' number' inputs).< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -property -private" >
< a href = "classes/footnotes-includes-settings-Setting.html#property_input_min" > $input_min< / a >
< span >
: int|float|null < / span >
< / dt >
< dd > Setting input field min. value (for ' number' inputs).< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -property -private" >
< a href = "classes/footnotes-includes-settings-Setting.html#property_input_options" > $input_options< / a >
< span >
: array< string|int, mixed> |null < / span >
< / dt >
< dd > Setting input field options (for ' select' inputs).< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -property -private" >
< a href = "classes/footnotes-includes-settings-Setting.html#property_input_type" > $input_type< / a >
< span >
: string < / span >
< / dt >
< dd > Setting input field type.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -property -private" >
< a href = "classes/footnotes-includes-settings-Setting.html#property_options_group_slug" > $options_group_slug< / a >
< span >
: string < / span >
< / dt >
< dd > Setting section slug.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -property -private" >
< a href = "classes/footnotes-includes-settings-Setting.html#property_overridden_by" > $overridden_by< / a >
< span >
: string|null < / span >
< / dt >
< dd > Any setting that overrides this setting.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -property -private" >
< a href = "classes/footnotes-includes-settings-Setting.html#property_section_slug" > $section_slug< / a >
< span >
: string < / span >
< / dt >
< dd > Setting section slug.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -property -private" >
< a href = "classes/footnotes-includes-settings-Setting.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 -private" >
< a href = "classes/footnotes-includes-settings-Setting.html#property_type" > $type< / a >
< span >
: string < / span >
< / dt >
< dd > Setting data type.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/footnotes-includes-settings-Setting.html#method___construct" > __construct()< / a >
< span >
: mixed < / span >
< / dt >
< dd > Constructs the setting.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/footnotes-includes-settings-Setting.html#method_get_default_value" > get_default_value()< / a >
< span >
: mixed < / span >
< / dt >
< dd > Gets the default value of the setting.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/footnotes-includes-settings-Setting.html#method_get_input_options" > get_input_options()< / a >
< span >
: array< string|int, mixed> |null < / span >
< / dt >
< dd > Gets the input options of the setting.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/footnotes-includes-settings-Setting.html#method_get_options_group_slug" > get_options_group_slug()< / a >
< span >
: string < / span >
< / dt >
< dd > Gets the slug of the setting' s options group.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/footnotes-includes-settings-Setting.html#method_get_section_slug" > get_section_slug()< / a >
< span >
: string < / span >
< / dt >
< dd > Gets the slug of the setting' s section.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/footnotes-includes-settings-Setting.html#method_get_setting_args" > get_setting_args()< / a >
< span >
: array< string|int, mixed> < / span >
< / dt >
< dd > Get the args for registering the settings with WordPress.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/footnotes-includes-settings-Setting.html#method_get_setting_field_args" > get_setting_field_args()< / a >
< span >
: array< string|int, mixed> < / span >
< / dt >
< dd > Get the args for rendering setting fields on the admin. dashboard.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/footnotes-includes-settings-Setting.html#method_get_value" > get_value()< / a >
< span >
: mixed < / span >
< / dt >
< dd > Gets the value of the setting.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/footnotes-includes-settings-Setting.html#method_set_value" > set_value()< / a >
< span >
: bool < / span >
< / dt >
< dd > Sets the value of the setting.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -private" >
< a href = "classes/footnotes-includes-settings-Setting.html#method_is_disabled_or_overridden" > is_disabled_or_overridden()< / a >
< span >
: bool|null < / span >
< / dt >
< dd > Check whether a setting is enabled and/or overridden.< / dd >
< / dl >
< section class = "phpdocumentor-constants" >
< h3 class = "phpdocumentor-elements__header" id = "constants" >
Constants
< a href = "classes/footnotes-includes-settings-Setting.html#constants" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h3 >
< article class = "phpdocumentor-element -constant -public " >
< h4 class = "phpdocumentor-element__name" id = "constant_FONT_SIZE_UNIT_OPTIONS" >
FONT_SIZE_UNIT_OPTIONS
< a href = "classes/footnotes-includes-settings-Setting.html#constant_FONT_SIZE_UNIT_OPTIONS" 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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 44< / span >
< / aside >
< p class = "phpdocumentor-summary" > Options for the custom font size units (per cent is a ratio, not a unit).< / p >
< code class = "phpdocumentor-signature phpdocumentor-code " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__type" > array< string|int, mixed> < / span >
< span class = "phpdocumentor-signature__name" > FONT_SIZE_UNIT_OPTIONS< / span >
= < span class = "phpdocumentor-signature__default-value" > array(' em' => ' em' , ' rem' => ' rem' , ' px' => ' pixels' , ' pt' => ' points' , ' pc' => ' picas' , ' mm' => ' millimeters' , ' %' => ' per cent' )< / 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" > 2.8.0< / span >
< / dd >
< / dl >
< / article >
< article class = "phpdocumentor-element -constant -public " >
< h4 class = "phpdocumentor-element__name" id = "constant_TEXT_ELEMENT_OPTIONS" >
TEXT_ELEMENT_OPTIONS
< a href = "classes/footnotes-includes-settings-Setting.html#constant_TEXT_ELEMENT_OPTIONS" 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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 61< / span >
< / aside >
< p class = "phpdocumentor-summary" > Options for the HTML text elements.< / p >
< code class = "phpdocumentor-signature phpdocumentor-code " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__type" > array< string|int, mixed> < / span >
< span class = "phpdocumentor-signature__name" > TEXT_ELEMENT_OPTIONS< / span >
= < span class = "phpdocumentor-signature__default-value" > array(' p' => ' paragraph' , ' h2' => ' heading 2' , ' h3' => ' heading 3' , ' h4' => ' heading 4' , ' h5' => ' heading 5' , ' h6' => ' heading 6' )< / 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" > 2.8.0< / span >
< / dd >
< / dl >
< / article >
< article class = "phpdocumentor-element -constant -public " >
< h4 class = "phpdocumentor-element__name" id = "constant_WIDTH_UNIT_OPTIONS" >
WIDTH_UNIT_OPTIONS
< a href = "classes/footnotes-includes-settings-Setting.html#constant_WIDTH_UNIT_OPTIONS" 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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 29< / span >
< / aside >
< p class = "phpdocumentor-summary" > Options for the custom width units (per cent is a ratio, not a unit).< / p >
< code class = "phpdocumentor-signature phpdocumentor-code " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__type" > array< string|int, mixed> < / span >
< span class = "phpdocumentor-signature__name" > WIDTH_UNIT_OPTIONS< / span >
= < span class = "phpdocumentor-signature__default-value" > array(' %' => ' per cent' , ' px' => ' pixels' , ' rem' => ' root em' , ' em' => ' em' , ' vw' => ' viewport width' )< / 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" > 2.8.0< / span >
< / dd >
< / dl >
< / article >
< / section >
< section class = "phpdocumentor-properties" >
< h3 class = "phpdocumentor-elements__header" id = "properties" >
Properties
< a href = "classes/footnotes-includes-settings-Setting.html#properties" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h3 >
< article
class="
phpdocumentor-element
-property
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "property_description" >
$description
< a href = "classes/footnotes-includes-settings-Setting.html#property_description" 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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 135< / span >
< / aside >
< p class = "phpdocumentor-summary" > Setting description.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__type" > string|null< / span >
< span class = "phpdocumentor-signature__name" > $description< / 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" > 2.8.0< / span >
< / dd >
< / dl >
< / article >
< article
class="
phpdocumentor-element
-property
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "property_key" >
$key
< a href = "classes/footnotes-includes-settings-Setting.html#property_key" 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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 117< / span >
< / aside >
< p class = "phpdocumentor-summary" > Setting slug.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__type" > string< / span >
< span class = "phpdocumentor-signature__name" > $key< / 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" > 2.8.0< / span >
< / dd >
< / dl >
< / article >
< article
class="
phpdocumentor-element
-property
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "property_name" >
$name
< a href = "classes/footnotes-includes-settings-Setting.html#property_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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 126< / span >
< / aside >
< p class = "phpdocumentor-summary" > Setting name.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__type" > string< / span >
< span class = "phpdocumentor-signature__name" > $name< / 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" > 2.8.0< / span >
< / dd >
< / dl >
< / article >
< article
class="
phpdocumentor-element
-property
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "property_value" >
$value
< a href = "classes/footnotes-includes-settings-Setting.html#property_value" 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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 77< / span >
< / aside >
< p class = "phpdocumentor-summary" > Setting value.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__type" > mixed< / span >
< span class = "phpdocumentor-signature__name" > $value< / 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" > 2.8.0< / span >
< / dd >
< / dl >
< / article >
< article
class="
phpdocumentor-element
-property
-private
"
>
< h4 class = "phpdocumentor-element__name" id = "property_default_value" >
$default_value
< a href = "classes/footnotes-includes-settings-Setting.html#property_default_value" 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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 144< / span >
< / aside >
< p class = "phpdocumentor-summary" > Setting default value.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > private< / span >
< span class = "phpdocumentor-signature__type" > mixed< / span >
< span class = "phpdocumentor-signature__name" > $default_value< / 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" > 2.8.0< / span >
< / dd >
< / dl >
< / article >
< article
class="
phpdocumentor-element
-property
-private
"
>
< h4 class = "phpdocumentor-element__name" id = "property_enabled_by" >
$enabled_by
< a href = "classes/footnotes-includes-settings-Setting.html#property_enabled_by" 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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 198< / span >
< / aside >
< p class = "phpdocumentor-summary" > The setting for whether this setting is enabled or not.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > private< / span >
< span class = "phpdocumentor-signature__type" > string|null< / span >
< span class = "phpdocumentor-signature__name" > $enabled_by< / 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" > 2.8.0< / span >
< / dd >
< / dl >
< / article >
< article
class="
phpdocumentor-element
-property
-private
"
>
< h4 class = "phpdocumentor-element__name" id = "property_group_id" >
$group_id
< a href = "classes/footnotes-includes-settings-Setting.html#property_group_id" 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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 92< / span >
< / aside >
< p class = "phpdocumentor-summary" > Setting group ID.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > private< / span >
< span class = "phpdocumentor-signature__type" > string< / span >
< span class = "phpdocumentor-signature__name" > $group_id< / 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" > 2.8.0< / span >
< / dd >
< / dl >
< / article >
< article
class="
phpdocumentor-element
-property
-private
"
>
< h4 class = "phpdocumentor-element__name" id = "property_input_max" >
$input_max
< a href = "classes/footnotes-includes-settings-Setting.html#property_input_max" 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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 180< / span >
< / aside >
< p class = "phpdocumentor-summary" > Setting input field max. value (for ' number' inputs).< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > private< / span >
< span class = "phpdocumentor-signature__type" > int|float|null< / span >
< span class = "phpdocumentor-signature__name" > $input_max< / 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" > 2.8.0< / span >
< / dd >
< / dl >
< / article >
< article
class="
phpdocumentor-element
-property
-private
"
>
< h4 class = "phpdocumentor-element__name" id = "property_input_min" >
$input_min
< a href = "classes/footnotes-includes-settings-Setting.html#property_input_min" 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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 189< / span >
< / aside >
< p class = "phpdocumentor-summary" > Setting input field min. value (for ' number' inputs).< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > private< / span >
< span class = "phpdocumentor-signature__type" > int|float|null< / span >
< span class = "phpdocumentor-signature__name" > $input_min< / 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" > 2.8.0< / span >
< / dd >
< / dl >
< / article >
< article
class="
phpdocumentor-element
-property
-private
"
>
< h4 class = "phpdocumentor-element__name" id = "property_input_options" >
$input_options
< a href = "classes/footnotes-includes-settings-Setting.html#property_input_options" 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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 171< / span >
< / aside >
< p class = "phpdocumentor-summary" > Setting input field options (for ' select' inputs).< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > private< / span >
< span class = "phpdocumentor-signature__type" > array< string|int, mixed> |null< / span >
< span class = "phpdocumentor-signature__name" > $input_options< / 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" > 2.8.0< / span >
< / dd >
< / dl >
< / article >
< article
class="
phpdocumentor-element
-property
-private
"
>
< h4 class = "phpdocumentor-element__name" id = "property_input_type" >
$input_type
< a href = "classes/footnotes-includes-settings-Setting.html#property_input_type" 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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 162< / span >
< / aside >
< p class = "phpdocumentor-summary" > Setting input field type.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > private< / span >
< span class = "phpdocumentor-signature__type" > string< / span >
< span class = "phpdocumentor-signature__name" > $input_type< / 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" > 2.8.0< / span >
< / dd >
< / dl >
< / article >
< article
class="
phpdocumentor-element
-property
-private
"
>
< h4 class = "phpdocumentor-element__name" id = "property_options_group_slug" >
$options_group_slug
< a href = "classes/footnotes-includes-settings-Setting.html#property_options_group_slug" 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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 100< / span >
< / aside >
< p class = "phpdocumentor-summary" > Setting section slug.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > private< / span >
< span class = "phpdocumentor-signature__type" > string< / span >
< span class = "phpdocumentor-signature__name" > $options_group_slug< / 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" > 2.8.0< / span >
< / dd >
< / dl >
< / article >
< article
class="
phpdocumentor-element
-property
-private
"
>
< h4 class = "phpdocumentor-element__name" id = "property_overridden_by" >
$overridden_by
< a href = "classes/footnotes-includes-settings-Setting.html#property_overridden_by" 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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 207< / span >
< / aside >
< p class = "phpdocumentor-summary" > Any setting that overrides this setting.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > private< / span >
< span class = "phpdocumentor-signature__type" > string|null< / span >
< span class = "phpdocumentor-signature__name" > $overridden_by< / 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" > 2.8.0< / span >
< / dd >
< / dl >
< / article >
< article
class="
phpdocumentor-element
-property
-private
"
>
< h4 class = "phpdocumentor-element__name" id = "property_section_slug" >
$section_slug
< a href = "classes/footnotes-includes-settings-Setting.html#property_section_slug" 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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 108< / span >
< / aside >
< p class = "phpdocumentor-summary" > Setting section slug.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > private< / span >
< span class = "phpdocumentor-signature__type" > string< / span >
< span class = "phpdocumentor-signature__name" > $section_slug< / 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" > 2.8.0< / span >
< / dd >
< / dl >
< / article >
< article
class="
phpdocumentor-element
-property
-private
"
>
< h4 class = "phpdocumentor-element__name" id = "property_settings" >
$settings
< a href = "classes/footnotes-includes-settings-Setting.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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 216< / span >
< / aside >
< p class = "phpdocumentor-summary" > The plugin settings object.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > private< / 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 >
< 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 >
< / article >
< article
class="
phpdocumentor-element
-property
-private
"
>
< h4 class = "phpdocumentor-element__name" id = "property_type" >
$type
< a href = "classes/footnotes-includes-settings-Setting.html#property_type" 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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 153< / span >
< / aside >
< p class = "phpdocumentor-summary" > Setting data type.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > private< / span >
< span class = "phpdocumentor-signature__type" > string< / span >
< span class = "phpdocumentor-signature__name" > $type< / 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" > 2.8.0< / span >
< / dd >
< / dl >
< / article >
< / section >
< section class = "phpdocumentor-methods" >
< h3 class = "phpdocumentor-elements__header" id = "methods" >
Methods
< a href = "classes/footnotes-includes-settings-Setting.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-includes-settings-Setting.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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 84< / span >
< / aside >
< p class = "phpdocumentor-summary" > Constructs the setting.< / 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" > $group_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" > $options_group_slug< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $section_slug< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $key< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $name< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > string|null < / span > < span class = "phpdocumentor-signature__argument__name" > $description< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > mixed < / span > < span class = "phpdocumentor-signature__argument__name" > $default_value< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $type< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $input_type< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > array< string|int, mixed> |null < / span > < span class = "phpdocumentor-signature__argument__name" > $input_options< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > int|float|null < / span > < span class = "phpdocumentor-signature__argument__name" > $input_max< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > int|float|null < / span > < span class = "phpdocumentor-signature__argument__name" > $input_min< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > string|null < / span > < span class = "phpdocumentor-signature__argument__name" > $enabled_by< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > string|null < / span > < span class = "phpdocumentor-signature__argument__name" > $overridden_by< / 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" > $group_id< / 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" > $options_group_slug< / 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" > $section_slug< / 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" > $key< / 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" > $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" > $description< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string|null< / 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" > $default_value< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > mixed< / 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" > $type< / 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" > $input_type< / 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" > $input_options< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > array< string|int, mixed> |null< / 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" > $input_max< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > int|float|null< / 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" > $input_min< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > int|float|null< / 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" > $enabled_by< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string|null< / 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" > $overridden_by< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string|null< / 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_get_default_value" >
get_default_value()
< a href = "classes/footnotes-includes-settings-Setting.html#method_get_default_value" 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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
2021-08-09 11:49:15 +01:00
< span class = "phpdocumentor-element-found-in__line" > 342< / span >
2021-08-09 11:27:33 +01:00
< / aside >
< p class = "phpdocumentor-summary" > Gets the default value of the setting.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__name" > get_default_value< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > 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" > 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 >
—
< section class = "phpdocumentor-description" > < p > The default value of the setting. 'None' if one is not set.< / p >
< / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_get_input_options" >
get_input_options()
< a href = "classes/footnotes-includes-settings-Setting.html#method_get_input_options" 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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
2021-08-09 11:49:15 +01:00
< span class = "phpdocumentor-element-found-in__line" > 353< / span >
2021-08-09 11:27:33 +01:00
< / aside >
< p class = "phpdocumentor-summary" > Gets the input options of the setting.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__name" > get_input_options< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > array< string|int, mixed> |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" > 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" > array< string|int, mixed> |null< / span >
—
< section class = "phpdocumentor-description" > < p > The possible options of the setting. 'None' if no options are set.< / p >
< / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_get_options_group_slug" >
get_options_group_slug()
< a href = "classes/footnotes-includes-settings-Setting.html#method_get_options_group_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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
2021-08-09 11:49:15 +01:00
< span class = "phpdocumentor-element-found-in__line" > 309< / span >
2021-08-09 11:27:33 +01:00
< / aside >
< p class = "phpdocumentor-summary" > Gets the slug of the setting' s options group.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__name" > get_options_group_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" > 2.8.0< / span >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > string< / span >
—
< section class = "phpdocumentor-description" > < p > The options group slug.< / p >
< / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_get_section_slug" >
get_section_slug()
< a href = "classes/footnotes-includes-settings-Setting.html#method_get_section_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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
2021-08-09 11:49:15 +01:00
< span class = "phpdocumentor-element-found-in__line" > 320< / span >
2021-08-09 11:27:33 +01:00
< / aside >
< p class = "phpdocumentor-summary" > Gets the slug of the setting' s section.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__name" > get_section_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" > 2.8.0< / span >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > string< / span >
—
< section class = "phpdocumentor-description" > < p > The section slug.< / p >
< / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_get_setting_args" >
get_setting_args()
< a href = "classes/footnotes-includes-settings-Setting.html#method_get_setting_args" 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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 232< / span >
< / aside >
< p class = "phpdocumentor-summary" > Get the args for registering the settings with WordPress.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__name" > get_setting_args< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > 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" > < abbr title = "\footnotes\includes\settings\register_setting()" > register_setting()< / abbr > < / 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 >
< / 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 > The setting field args.< / p >
< / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_get_setting_field_args" >
get_setting_field_args()
< a href = "classes/footnotes-includes-settings-Setting.html#method_get_setting_field_args" 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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 249< / span >
< / aside >
< p class = "phpdocumentor-summary" > Get the args for rendering setting fields on the admin. dashboard.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__name" > get_setting_field_args< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > 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" > < abbr title = "\footnotes\includes\settings\add_settings_field()" > add_settings_field()< / abbr > < / 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 >
< / 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 > The setting field args.< / p >
< / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_get_value" >
get_value()
< a href = "classes/footnotes-includes-settings-Setting.html#method_get_value" 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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
2021-08-09 11:49:15 +01:00
< span class = "phpdocumentor-element-found-in__line" > 331< / span >
2021-08-09 11:27:33 +01:00
< / aside >
< p class = "phpdocumentor-summary" > Gets the value of the setting.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__name" > get_value< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > 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" > 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 >
—
< section class = "phpdocumentor-description" > < p > The value of the setting, or the default value if none is set. 'None' if neither are set.< / p >
< / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_set_value" >
set_value()
< a href = "classes/footnotes-includes-settings-Setting.html#method_set_value" 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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
2021-08-09 11:49:15 +01:00
< span class = "phpdocumentor-element-found-in__line" > 365< / span >
2021-08-09 11:27:33 +01:00
< / aside >
< p class = "phpdocumentor-summary" > Sets the value of the setting.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__name" > set_value< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > mixed < / span > < span class = "phpdocumentor-signature__argument__name" > $value< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > bool< / 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" > $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 >
< 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" > bool< / span >
—
< section class = "phpdocumentor-description" > < p > 'True' if the value was successfully set. 'False' otherwise.< / p >
< / section >
< / article >
< article
class="phpdocumentor-element
-method
-private
"
>
< h4 class = "phpdocumentor-element__name" id = "method_is_disabled_or_overridden" >
is_disabled_or_overridden()
< a href = "classes/footnotes-includes-settings-Setting.html#method_is_disabled_or_overridden" 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/includes/settings/class-setting.php" > < a href = "files/src-includes-settings-class-setting.html" > < abbr title = "src/includes/settings/class-setting.php" > class-setting.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 272< / span >
< / aside >
< p class = "phpdocumentor-summary" > Check whether a setting is enabled and/or overridden.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > private< / span >
< span class = "phpdocumentor-signature__name" > is_disabled_or_overridden< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > bool|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" > 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" > bool|null< / span >
—
< section class = "phpdocumentor-description" > < p > 'True' if the setting is disabled or overridden.
'False' if it could be, but isn't currently.
'None' if the setting is not enabled/overridden by another.< / 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-includes-settings-Setting.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 >