2021-02-20 19:55:52 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > Documentation< / title >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< base href = "../" >
< link rel = "icon" href = "images/favicon.ico" / >
< link rel = "stylesheet" href = "css/normalize.css" >
< link rel = "stylesheet" href = "css/base.css" >
< link href = "https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel = "stylesheet" >
< link rel = "stylesheet" href = "css/template.css" >
< link rel = "stylesheet" href = "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity = "sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin = "anonymous" / >
< script src = "https://cdn.jsdelivr.net/npm/fuse.js@3.4.6" > < / script >
< script src = "https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2" > < / script >
< script src = "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/js/all.min.js" integrity = "sha256-0vuk8LXoyrmCjp1f0O300qo1M75ZQyhH9X3J6d+scmk=" crossorigin = "anonymous" > < / script >
< script src = "js/search.js" > < / script >
< script defer src = "js/searchIndex.js" > < / script >
< / head >
< body id = "top" >
< header class = "phpdocumentor-header phpdocumentor-section" >
< h1 class = "phpdocumentor-title" > < a href = "" class = "phpdocumentor-title__link" > Documentation< / a > < / h1 >
< input class = "phpdocumentor-header__menu-button" type = "checkbox" id = "menu-button" name = "menu-button" / >
< label class = "phpdocumentor-header__menu-icon" for = "menu-button" >
< i class = "fas fa-bars" > < / i >
< / label >
< section data-search-form class = "phpdocumentor-search" >
< label >
< span class = "visually-hidden" > Search for< / span >
< svg class = "phpdocumentor-search__icon" width = "21" height = "20" viewBox = "0 0 21 20" fill = "none" xmlns = "http://www.w3.org/2000/svg" >
< circle cx = "7.5" cy = "7.5" r = "6.5" stroke = "currentColor" stroke-width = "2" / >
< line x1 = "12.4892" y1 = "12.2727" x2 = "19.1559" y2 = "18.9393" stroke = "currentColor" stroke-width = "3" / >
< / svg >
< input type = "search" class = "phpdocumentor-field phpdocumentor-search__field" placeholder = "Loading .." disabled / >
< / label >
< / section >
< nav class = "phpdocumentor-topnav" >
< ul class = "phpdocumentor-topnav__menu" >
< / ul >
< / nav >
< / header >
< main class = "phpdocumentor" >
< div class = "phpdocumentor-section" >
< input class = "phpdocumentor-sidebar__menu-button" type = "checkbox" id = "sidebar-button" name = "sidebar-button" / >
< label class = "phpdocumentor-sidebar__menu-icon" for = "sidebar-button" >
Menu
< / label >
< aside class = "phpdocumentor-column -four phpdocumentor-sidebar" >
< section class = "phpdocumentor-sidebar__category" >
< h2 class = "phpdocumentor-sidebar__category-header" > Namespaces< / h2 >
< h3 class = "phpdocumentor-sidebar__root-namespace" > < a href = "namespaces/default.html" > < abbr title = "\" > Global< / abbr > < / a > < / h3 >
< / 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" >
2021-04-18 19:30:42 +00:00
< li class = "phpdocumentor-breadcrumb" > < a href = "packages/footnotes.html" > footnotes< / a > < / li >
2021-02-20 19:55:52 +00:00
< / ul >
< article class = "phpdocumentor-element -class" >
< h2 class = "phpdocumentor-content__title" >
2021-04-25 08:28:02 +00:00
Footnotes_Widget_Base
2021-02-20 19:55:52 +00:00
< span class = "phpdocumentor-element__extends" >
extends < abbr title = "\WP_Widget" > WP_Widget< / abbr >
< / span >
< / h2 >
< aside class = "phpdocumentor-element-found-in" >
2021-04-25 08:28:02 +00:00
< abbr class = "phpdocumentor-element-found-in__file" title = "src/class/widgets/base.php" > < a href = "files/src-class-widgets-base.html" > < abbr title = "src/class/widgets/base.php" > base.php< / abbr > < / a > < / abbr >
2021-02-20 19:55:52 +00:00
:
2021-04-18 19:30:42 +00:00
< span class = "phpdocumentor-element-found-in__line" > 21< / span >
2021-02-20 19:55:52 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Base Class for all Plugin Widgets. Registers each Widget to WordPress.< / p >
< section class = "phpdocumentor-description" > < p > The following Methods MUST be overwritten in each sub class:
< strong > public function widget($args, $instance)< / strong > -> echo the Widget Content
< strong > public function form($instance)< / strong > -> echo the Settings of the Widget< / p >
< / section >
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > author< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< section class = "phpdocumentor-description" > < p > Stefan Herndler< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 1.5.0< / span >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< 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 -method -public" >
2021-04-25 08:28:02 +00:00
< a href = "classes/Footnotes-Widget-Base.html#method___construct" > __construct()< / a >
2021-02-20 19:55:52 +00:00
< span >
: mixed < / span >
< / dt >
< dd > Class Constructor. Registers the child Widget to WordPress.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
2021-04-25 08:28:02 +00:00
< a href = "classes/Footnotes-Widget-Base.html#method_get_description" > get_description()< / a >
2021-02-20 19:55:52 +00:00
< span >
: string < / span >
< / dt >
< dd > Returns the Description of the child widget.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
2021-04-25 08:28:02 +00:00
< a href = "classes/Footnotes-Widget-Base.html#method_get_id" > get_id()< / a >
2021-02-20 19:55:52 +00:00
< span >
: string < / span >
< / dt >
< dd > Returns an unique ID as string used for the Widget Base ID.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
2021-04-25 08:28:02 +00:00
< a href = "classes/Footnotes-Widget-Base.html#method_get_name" > get_name()< / a >
2021-02-20 19:55:52 +00:00
< span >
: string < / span >
< / dt >
< dd > Returns the Public name of child Widget to be displayed in the Configuration page.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
2021-04-25 08:28:02 +00:00
< a href = "classes/Footnotes-Widget-Base.html#method_get_widget_width" > get_widget_width()< / a >
2021-02-20 19:55:52 +00:00
< span >
: int < / span >
< / dt >
< dd > Returns the width of the Widget. Default width is 250 pixel.< / dd >
< / dl >
< section class = "phpdocumentor-methods" >
< h3 class = "phpdocumentor-elements__header" id = "methods" >
Methods
2021-04-25 08:28:02 +00:00
< a href = "classes/Footnotes-Widget-Base.html#methods" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
2021-02-20 19:55:52 +00:00
< / h3 >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method___construct" >
__construct()
2021-04-25 08:28:02 +00:00
< a href = "classes/Footnotes-Widget-Base.html#method___construct" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
2021-02-20 19:55:52 +00:00
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
2021-04-25 08:28:02 +00:00
< abbr class = "phpdocumentor-element-found-in__file" title = "src/class/widgets/base.php" > < a href = "files/src-class-widgets-base.html" > < abbr title = "src/class/widgets/base.php" > base.php< / abbr > < / a > < / abbr >
2021-02-20 19:55:52 +00:00
:
2021-04-18 19:30:42 +00:00
< span class = "phpdocumentor-element-found-in__line" > 69< / span >
2021-02-20 19:55:52 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Class Constructor. Registers the child Widget to WordPress.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__name" > __construct< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > mixed< / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 1.5.0< / span >
< section class = "phpdocumentor-description" > < ul >
< li > Update: replace deprecated function WP_Widget() with recommended __construct(), thanks to @dartiss code contribution.< / li >
< / ul >
< / section >
< / dd >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 1.6.4< / span >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > contributor< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< section class = "phpdocumentor-description" > < p > @dartiss< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > link< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
2021-04-25 08:28:02 +00:00
< a class = "phpdocumentor-tag-link" href = "https://plugins.trac.wordpress.org/browser/footnotes/trunk/class/widgets/base.php?rev=1445720" > < p > “The called constructor method for WP_Widget in Footnotes_Widget_ReferenceContainer is deprecated since version 4.3.0! Use __construct() instead.”< / p >
2021-02-20 19:55:52 +00:00
< / a >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > mixed< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
-abstract "
>
2021-04-18 19:30:42 +00:00
< h4 class = "phpdocumentor-element__name" id = "method_get_description" >
get_description()
2021-04-25 08:28:02 +00:00
< a href = "classes/Footnotes-Widget-Base.html#method_get_description" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
2021-02-20 19:55:52 +00:00
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
2021-04-25 08:28:02 +00:00
< abbr class = "phpdocumentor-element-found-in__file" title = "src/class/widgets/base.php" > < a href = "files/src-class-widgets-base.html" > < abbr title = "src/class/widgets/base.php" > base.php< / abbr > < / a > < / abbr >
2021-02-20 19:55:52 +00:00
:
2021-04-18 19:30:42 +00:00
< span class = "phpdocumentor-element-found-in__line" > 45< / span >
2021-02-20 19:55:52 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Returns the Description of the child widget.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
2021-04-18 19:30:42 +00:00
< span class = "phpdocumentor-signature__abstract" > abstract< / span > < span class = "phpdocumentor-signature__name" > get_description< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > string< / span > < / code >
2021-02-20 19:55:52 +00:00
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 1.5.0< / span >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > string< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
-abstract "
>
2021-04-18 19:30:42 +00:00
< h4 class = "phpdocumentor-element__name" id = "method_get_id" >
get_id()
2021-04-25 08:28:02 +00:00
< a href = "classes/Footnotes-Widget-Base.html#method_get_id" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
2021-02-20 19:55:52 +00:00
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
2021-04-25 08:28:02 +00:00
< abbr class = "phpdocumentor-element-found-in__file" title = "src/class/widgets/base.php" > < a href = "files/src-class-widgets-base.html" > < abbr title = "src/class/widgets/base.php" > base.php< / abbr > < / a > < / abbr >
2021-02-20 19:55:52 +00:00
:
2021-04-18 19:30:42 +00:00
< span class = "phpdocumentor-element-found-in__line" > 29< / span >
2021-02-20 19:55:52 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Returns an unique ID as string used for the Widget Base ID.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
2021-04-18 19:30:42 +00:00
< span class = "phpdocumentor-signature__abstract" > abstract< / span > < span class = "phpdocumentor-signature__name" > get_id< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > string< / span > < / code >
2021-02-20 19:55:52 +00:00
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 1.5.0< / span >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > string< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
-abstract "
>
2021-04-18 19:30:42 +00:00
< h4 class = "phpdocumentor-element__name" id = "method_get_name" >
get_name()
2021-04-25 08:28:02 +00:00
< a href = "classes/Footnotes-Widget-Base.html#method_get_name" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
2021-02-20 19:55:52 +00:00
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
2021-04-25 08:28:02 +00:00
< abbr class = "phpdocumentor-element-found-in__file" title = "src/class/widgets/base.php" > < a href = "files/src-class-widgets-base.html" > < abbr title = "src/class/widgets/base.php" > base.php< / abbr > < / a > < / abbr >
2021-02-20 19:55:52 +00:00
:
2021-04-18 19:30:42 +00:00
< span class = "phpdocumentor-element-found-in__line" > 37< / span >
2021-02-20 19:55:52 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Returns the Public name of child Widget to be displayed in the Configuration page.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
2021-04-18 19:30:42 +00:00
< span class = "phpdocumentor-signature__abstract" > abstract< / span > < span class = "phpdocumentor-signature__name" > get_name< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > string< / span > < / code >
2021-02-20 19:55:52 +00:00
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 1.5.0< / span >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > string< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
2021-04-18 19:30:42 +00:00
< h4 class = "phpdocumentor-element__name" id = "method_get_widget_width" >
get_widget_width()
2021-04-25 08:28:02 +00:00
< a href = "classes/Footnotes-Widget-Base.html#method_get_widget_width" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
2021-02-20 19:55:52 +00:00
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
2021-04-25 08:28:02 +00:00
< abbr class = "phpdocumentor-element-found-in__file" title = "src/class/widgets/base.php" > < a href = "files/src-class-widgets-base.html" > < abbr title = "src/class/widgets/base.php" > base.php< / abbr > < / a > < / abbr >
2021-02-20 19:55:52 +00:00
:
2021-04-18 19:30:42 +00:00
< span class = "phpdocumentor-element-found-in__line" > 53< / span >
2021-02-20 19:55:52 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Returns the width of the Widget. Default width is 250 pixel.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
2021-04-18 19:30:42 +00:00
< span class = "phpdocumentor-signature__name" > get_widget_width< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > int< / span > < / code >
2021-02-20 19:55:52 +00:00
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 1.5.0< / span >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > int< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< / section >
< / article >
< section data-search-results class = "phpdocumentor-search-results phpdocumentor-search-results--hidden" >
< section class = "phpdocumentor-search-results__dialog" >
< header class = "phpdocumentor-search-results__header" >
< h2 class = "phpdocumentor-search-results__title" > Search results< / h2 >
< button class = "phpdocumentor-search-results__close" > < i class = "fas fa-times" > < / i > < / button >
< / header >
< section class = "phpdocumentor-search-results__body" >
< ul class = "phpdocumentor-search-results__entries" > < / ul >
< / section >
< / section >
< / section >
< / div >
< / div >
2021-04-25 08:28:02 +00:00
< a href = "classes/Footnotes-Widget-Base.html#top" class = "phpdocumentor-back-to-top" > < i class = "fas fa-chevron-circle-up" > < / i > < / a >
2021-02-20 19:55:52 +00:00
< / main >
< script >
cssVars({});
< / script >
< / body >
< / html >
