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>
|
2021-04-26 22:06:10 +00:00
|
|
|
</section>
|
2021-02-20 19:55:52 +00:00
|
|
|
|
2021-04-26 22:06:10 +00:00
|
|
|
<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">
|
2021-04-27 09:04:30 +00:00
|
|
|
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
|
|
|
|
|
<li><a href="packages/footnotes-admin.html"><abbr title="\footnotes\admin">admin</abbr></a></li>
|
|
|
|
|
<li><a href="packages/footnotes-public.html"><abbr title="\footnotes\public">public</abbr></a></li>
|
2021-04-26 22:06:10 +00:00
|
|
|
</ul>
|
|
|
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
|
|
|
|
|
</section>
|
2021-02-20 19:55:52 +00:00
|
|
|
|
|
|
|
|
<section class="phpdocumentor-sidebar__category">
|
|
|
|
|
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
|
|
|
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
|
|
|
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
|
|
|
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-sidebar__category">
|
|
|
|
|
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
|
|
|
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
|
|
|
|
|
</section>
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<div class="phpdocumentor-column -eight phpdocumentor-content">
|
|
|
|
|
<ul class="phpdocumentor-breadcrumbs">
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<article class="phpdocumentor-element -namespace">
|
|
|
|
|
<h2 class="phpdocumentor-content__title">API Documentation</h2>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="interfaces_class_traits">
|
|
|
|
|
Interfaces, Classes and Traits
|
|
|
|
|
<a href="#interfaces_class_traits" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
|
</h3>
|
|
|
|
|
|
|
|
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
|
|
|
|
2021-04-26 22:06:10 +00:00
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Activator.html"><abbr title="\Footnotes_Activator">Footnotes_Activator</abbr></a></dt>
|
|
|
|
|
<dd>Fired during plugin activation.</dd>
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Deactivator.html"><abbr title="\Footnotes_Deactivator">Footnotes_Deactivator</abbr></a></dt>
|
|
|
|
|
<dd>Fired during plugin deactivation.</dd>
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes.html"><abbr title="\Footnotes">Footnotes</abbr></a></dt>
|
|
|
|
|
<dd>The core plugin class.</dd>
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Admin.html"><abbr title="\Footnotes_Admin">Footnotes_Admin</abbr></a></dt>
|
|
|
|
|
<dd>The admin-specific functionality of the plugin.</dd>
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-WYSIWYG.html"><abbr title="\Footnotes_WYSIWYG">Footnotes_WYSIWYG</abbr></a></dt>
|
|
|
|
|
<dd>Handles the WSYIWYG-Buttons.</dd>
|
2021-04-25 08:28:02 +00:00
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Layout-Engine.html"><abbr title="\Footnotes_Layout_Engine">Footnotes_Layout_Engine</abbr></a></dt>
|
2021-02-20 19:55:52 +00:00
|
|
|
<dd>Layout Engine for the administration dashboard.</dd>
|
2021-04-26 22:06:10 +00:00
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Layout-Init.html"><abbr title="\Footnotes_Layout_Init">Footnotes_Layout_Init</abbr></a></dt>
|
|
|
|
|
<dd>Handles the Settings interface of the Plugin.</dd>
|
2021-04-25 08:28:02 +00:00
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Layout-Settings.html"><abbr title="\Footnotes_Layout_Settings">Footnotes_Layout_Settings</abbr></a></dt>
|
2021-02-20 19:55:52 +00:00
|
|
|
<dd>Displays and handles all Settings of the Plugin.</dd>
|
2021-04-26 22:06:10 +00:00
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Config.html"><abbr title="\Footnotes_Config">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/Footnotes-Convert.html"><abbr title="\Footnotes_Convert">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/Footnotes-i18n.html"><abbr title="\Footnotes_i18n">Footnotes_i18n</abbr></a></dt>
|
|
|
|
|
<dd>Define the internationalization functionality.</dd>
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Loader.html"><abbr title="\Footnotes_Loader">Footnotes_Loader</abbr></a></dt>
|
|
|
|
|
<dd>Register all actions and filters for the plugin.</dd>
|
2021-04-25 08:28:02 +00:00
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Settings.html"><abbr title="\Footnotes_Settings">Footnotes_Settings</abbr></a></dt>
|
2021-02-20 19:55:52 +00:00
|
|
|
<dd>Loads the settings values, sets to default values if undefined.</dd>
|
2021-04-25 08:28:02 +00:00
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Template.html"><abbr title="\Footnotes_Template">Footnotes_Template</abbr></a></dt>
|
2021-02-20 19:55:52 +00:00
|
|
|
<dd>Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).</dd>
|
2021-04-26 22:06:10 +00:00
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Public.html"><abbr title="\Footnotes_Public">Footnotes_Public</abbr></a></dt>
|
|
|
|
|
<dd>The public-facing functionality of the plugin.</dd>
|
2021-04-25 08:28:02 +00:00
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Widget-Base.html"><abbr title="\Footnotes_Widget_Base">Footnotes_Widget_Base</abbr></a></dt>
|
2021-02-20 19:55:52 +00:00
|
|
|
<dd>Base Class for all Plugin Widgets. Registers each Widget to WordPress.</dd>
|
2021-04-25 08:28:02 +00:00
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Widget-Reference-Container.html"><abbr title="\Footnotes_Widget_Reference_Container">Footnotes_Widget_Reference_Container</abbr></a></dt>
|
2021-02-20 19:55:52 +00:00
|
|
|
<dd>Registers a Widget to put the Reference Container to the widget area.</dd>
|
2021-04-27 07:42:43 +00:00
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Parser.html"><abbr title="\Footnotes_Parser">Footnotes_Parser</abbr></a></dt>
|
|
|
|
|
<dd>Searches and replaces the footnotes and generates the reference container.</dd>
|
2021-02-20 19:55:52 +00:00
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
2021-04-25 08:28:02 +00: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-25 08:28:02 +00:00
|
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
2021-04-26 22:06:10 +00:00
|
|
|
<a href="namespaces/default.html#function_activate_footnotes">activate_footnotes()</a>
|
|
|
|
|
<span>
|
|
|
|
|
: mixed </span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd>The code that runs during plugin activation.</dd>
|
|
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
|
|
|
<a href="namespaces/default.html#function_deactivate_plugin_name">deactivate_plugin_name()</a>
|
2021-04-25 08:28:02 +00:00
|
|
|
<span>
|
|
|
|
|
: mixed </span>
|
|
|
|
|
</dt>
|
2021-04-26 22:06:10 +00:00
|
|
|
<dd>The code that runs during plugin deactivation.</dd>
|
|
|
|
|
|
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
|
|
|
<a href="namespaces/default.html#function_run_footnotes">run_footnotes()</a>
|
|
|
|
|
<span>
|
|
|
|
|
: mixed </span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd>Begins execution of the plugin.</dd>
|
2021-04-25 08:28:02 +00:00
|
|
|
|
|
|
|
|
</dl>
|
2021-02-20 19:55:52 +00:00
|
|
|
|
2021-04-18 19:30:42 +00:00
|
|
|
|
2021-04-25 08:28:02 +00:00
|
|
|
|
|
|
|
|
<section class="phpdocumentor-functions">
|
|
|
|
|
<h3 class="phpdocumentor-elements__header" id="functions">
|
|
|
|
|
Functions
|
|
|
|
|
<a href="namespaces/default.html#functions" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
|
</h3>
|
|
|
|
|
<article class="phpdocumentor-element -function - ">
|
2021-04-26 22:06:10 +00:00
|
|
|
<h4 class="phpdocumentor-element__name" id="function_activate_footnotes">
|
|
|
|
|
activate_footnotes()
|
|
|
|
|
<a href="namespaces/default.html#function_activate_footnotes" 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/footnotes.php"><a href="files/src-footnotes.html"><abbr title="src/footnotes.php">footnotes.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-04-27 08:41:35 +00:00
|
|
|
<span class="phpdocumentor-element-found-in__line">56</span>
|
2021-04-26 22:06:10 +00:00
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<p class="phpdocumentor-summary">The code that runs during plugin activation.</p>
|
|
|
|
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
|
|
<span class="phpdocumentor-signature__visibility"></span>
|
|
|
|
|
<span class="phpdocumentor-signature__name">activate_footnotes</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-description"><p>This action is documented in includes/class-plugin-name-activator.php</p>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
<article class="phpdocumentor-element -function - ">
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="function_deactivate_plugin_name">
|
|
|
|
|
deactivate_plugin_name()
|
|
|
|
|
<a href="namespaces/default.html#function_deactivate_plugin_name" class="headerlink"><i class="fas fa-link"></i></a>
|
2021-04-25 08:28:02 +00:00
|
|
|
</h4>
|
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
2021-04-26 22:06:10 +00:00
|
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/footnotes.php"><a href="files/src-footnotes.html"><abbr title="src/footnotes.php">footnotes.php</abbr></a></abbr>
|
2021-04-25 08:28:02 +00:00
|
|
|
:
|
2021-04-27 08:41:35 +00:00
|
|
|
<span class="phpdocumentor-element-found-in__line">65</span>
|
2021-04-25 08:28:02 +00:00
|
|
|
</aside>
|
|
|
|
|
|
2021-04-26 22:06:10 +00:00
|
|
|
<p class="phpdocumentor-summary">The code that runs during plugin deactivation.</p>
|
2021-04-25 08:28:02 +00:00
|
|
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
|
|
<span class="phpdocumentor-signature__visibility"></span>
|
2021-04-26 22:06:10 +00:00
|
|
|
<span class="phpdocumentor-signature__name">deactivate_plugin_name</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-description"><p>This action is documented in includes/class-plugin-name-deactivator.php</p>
|
2021-04-25 08:28:02 +00:00
|
|
|
</section>
|
|
|
|
|
|
2021-04-26 22:06:10 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
<article class="phpdocumentor-element -function - ">
|
|
|
|
|
<h4 class="phpdocumentor-element__name" id="function_run_footnotes">
|
|
|
|
|
run_footnotes()
|
|
|
|
|
<a href="namespaces/default.html#function_run_footnotes" 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/footnotes.php"><a href="files/src-footnotes.html"><abbr title="src/footnotes.php">footnotes.php</abbr></a></abbr>
|
|
|
|
|
:
|
2021-04-27 08:41:35 +00:00
|
|
|
<span class="phpdocumentor-element-found-in__line">88</span>
|
2021-04-26 22:06:10 +00:00
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<p class="phpdocumentor-summary">Begins execution of the plugin.</p>
|
|
|
|
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
|
|
<span class="phpdocumentor-signature__visibility"></span>
|
|
|
|
|
<span class="phpdocumentor-signature__name">run_footnotes</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-description"><p>Since everything within the plugin is registered via hooks,
|
|
|
|
|
then kicking off the plugin from this point in the file does
|
|
|
|
|
not affect the page life cycle.</p>
|
|
|
|
|
</section>
|
2021-04-25 08:28:02 +00:00
|
|
|
|
|
|
|
|
|
2021-04-26 22:06:10 +00:00
|
|
|
|
2021-04-25 08:28:02 +00:00
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
|
|
|
Tags
|
|
|
|
|
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
|
</h5>
|
|
|
|
|
<dl class="phpdocumentor-tag-list">
|
|
|
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
|
|
|
<span class="phpdocumentor-tag__name">since</span>
|
|
|
|
|
</dt>
|
|
|
|
|
<dd class="phpdocumentor-tag-list__definition">
|
2021-04-26 22:06:10 +00:00
|
|
|
<span class="phpdocumentor-tag-link">2.8.0</span>
|
2021-04-25 08:28:02 +00:00
|
|
|
|
|
|
|
|
<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>
|
|
|
|
|
<a href="namespaces/default.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
|
|
|
|
|
|
|
|
|
|
</main>
|
|
|
|
|
|
|
|
|
|
<script>
|
|
|
|
|
cssVars({});
|
|
|
|
|
</script>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
