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" >
< / ul >
< article class = "phpdocumentor-element -package" >
2021-04-18 00:53:37 +02:00
< h2 class = "phpdocumentor-content__title" > Default< / h2 >
2021-02-20 19:55:52 +00:00
2021-04-18 00:53:37 +02:00
< h3 id = "interfaces_class_traits" >
Interfaces, Classes and Traits
< a href = "#interfaces_class_traits" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
2021-02-20 19:55:52 +00:00
< / h3 >
< dl class = "phpdocumentor-table-of-contents" >
2021-04-18 00:53:37 +02:00
< dt class = "phpdocumentor-table-of-contents__entry -class" > < a href = "classes/MCI-Footnotes-Config.html" > < abbr title = "\MCI_Footnotes_Config" > MCI_Footnotes_Config< / abbr > < / a > < / dt >
< dd > Contains all Plugin Constants. Contains no Method or Property.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -class" > < a href = "classes/MCI-Footnotes-Convert.html" > < abbr title = "\MCI_Footnotes_Convert" > MCI_Footnotes_Convert< / abbr > < / a > < / dt >
< dd > Converts data types and Footnotes specific values.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -class" > < a href = "classes/MCI-Footnotes-Layout-Init.html" > < abbr title = "\MCI_Footnotes_Layout_Init" > MCI_Footnotes_Layout_Init< / abbr > < / a > < / dt >
< dd > Handles the Settings interface of the Plugin.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -class" > < a href = "classes/MCI-Footnotes-LayoutEngine.html" > < abbr title = "\MCI_Footnotes_LayoutEngine" > MCI_Footnotes_LayoutEngine< / abbr > < / a > < / dt >
< dd > Layout Engine for the administration dashboard.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -class" > < a href = "classes/MCI-Footnotes-Layout-Diagnostics.html" > < abbr title = "\MCI_Footnotes_Layout_Diagnostics" > MCI_Footnotes_Layout_Diagnostics< / abbr > < / a > < / dt >
< dd > Displays Diagnostics of the web server, PHP and WordPress.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -class" > < a href = "classes/MCI-Footnotes-Layout-Settings.html" > < abbr title = "\MCI_Footnotes_Layout_Settings" > MCI_Footnotes_Layout_Settings< / abbr > < / a > < / dt >
< dd > Displays and handles all Settings of the Plugin.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -class" > < a href = "classes/MCI-Footnotes-Hooks.html" > < abbr title = "\MCI_Footnotes_Hooks" > MCI_Footnotes_Hooks< / abbr > < / a > < / dt >
< dd > Registers all WordPress Hooks and executes them on demand.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -class" > < a href = "classes/MCI-Footnotes.html" > < abbr title = "\MCI_Footnotes" > MCI_Footnotes< / abbr > < / a > < / dt >
< dd > Entry point of the Plugin. Loads the Dashboard and executes the Task.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -class" > < a href = "classes/MCI-Footnotes-Language.html" > < abbr title = "\MCI_Footnotes_Language" > MCI_Footnotes_Language< / abbr > < / a > < / dt >
< dd > Loads text domain of current or default language for localization.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -class" > < a href = "classes/MCI-Footnotes-Settings.html" > < abbr title = "\MCI_Footnotes_Settings" > MCI_Footnotes_Settings< / abbr > < / a > < / dt >
< dd > Loads the settings values, sets to default values if undefined.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -class" > < a href = "classes/MCI-Footnotes-Task.html" > < abbr title = "\MCI_Footnotes_Task" > MCI_Footnotes_Task< / abbr > < / a > < / dt >
< dd > Searches and replaces the footnotes.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -class" > < a href = "classes/MCI-Footnotes-Template.html" > < abbr title = "\MCI_Footnotes_Template" > MCI_Footnotes_Template< / abbr > < / a > < / dt >
< dd > Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -class" > < a href = "classes/MCI-Footnotes-WidgetBase.html" > < abbr title = "\MCI_Footnotes_WidgetBase" > MCI_Footnotes_WidgetBase< / abbr > < / a > < / dt >
< dd > Base Class for all Plugin Widgets. Registers each Widget to WordPress.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -class" > < a href = "classes/MCI-Footnotes-Widget-ReferenceContainer.html" > < abbr title = "\MCI_Footnotes_Widget_ReferenceContainer" > MCI_Footnotes_Widget_ReferenceContainer< / abbr > < / a > < / dt >
< dd > Registers a Widget to put the Reference Container to the widget area.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -class" > < a href = "classes/MCI-Footnotes-WYSIWYG.html" > < abbr title = "\MCI_Footnotes_WYSIWYG" > MCI_Footnotes_WYSIWYG< / abbr > < / a > < / dt >
< dd > < / dd >
2021-02-20 19:55:52 +00:00
< / dl >
2021-04-18 00:53:37 +02:00
< h3 id = "toc" >
Table of Contents
< a href = "#toc" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h3 >
2021-02-20 19:55:52 +00:00
2021-04-18 00:53:37 +02:00
< dl class = "phpdocumentor-table-of-contents" >
< dt class = "phpdocumentor-table-of-contents__entry -function -" >
< a href = "namespaces/default.html#function_MCI_Footnotes_requirePhpFiles" > MCI_Footnotes_requirePhpFiles()< / a >
< span >
: mixed < / span >
< / dt >
< dd > Requires (require_once) all *.php files inside a specific Directory.< / dd >
2021-02-20 19:55:52 +00:00
2021-04-18 00:53:37 +02:00
< / dl >
2021-02-20 19:55:52 +00:00
2021-04-18 00:53:37 +02:00
< section class = "phpdocumentor-functions" >
< h3 class = "phpdocumentor-elements__header" id = "functions" >
Functions
< a href = "packages/Default.html#functions" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h3 >
< article class = "phpdocumentor-element -function - " >
< h4 class = "phpdocumentor-element__name" id = "function_MCI_Footnotes_requirePhpFiles" >
MCI_Footnotes_requirePhpFiles()
< a href = "namespaces/default.html#function_MCI_Footnotes_requirePhpFiles" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "includes.php" > < a href = "files/includes.html" > < abbr title = "includes.php" > includes.php< / abbr > < / a > < / abbr >
:
< span class = "phpdocumentor-element-found-in__line" > 17< / span >
< / aside >
< p class = "phpdocumentor-summary" > Requires (require_once) all *.php files inside a specific Directory.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > < / span >
< span class = "phpdocumentor-signature__name" > MCI_Footnotes_requirePhpFiles< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $p_str_Directory< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > mixed< / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $p_str_Directory< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > Absolute Directory path to lookup for *.php files< / 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" > 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 >
< / article >
< / section >
2021-02-20 19:55:52 +00:00
< / article >
< section data-search-results class = "phpdocumentor-search-results phpdocumentor-search-results--hidden" >
< section class = "phpdocumentor-search-results__dialog" >
< header class = "phpdocumentor-search-results__header" >
< h2 class = "phpdocumentor-search-results__title" > Search results< / h2 >
< button class = "phpdocumentor-search-results__close" > < i class = "fas fa-times" > < / i > < / button >
< / header >
< section class = "phpdocumentor-search-results__body" >
< ul class = "phpdocumentor-search-results__entries" > < / ul >
< / section >
< / section >
< / section >
< / div >
< / div >
2021-04-18 00:53:37 +02:00
< a href = "packages/Default.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 >