<!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> <h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h4> <ul class="phpdocumentor-list"> </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"> </ul> <article class="phpdocumentor-element -class"> <h2 class="phpdocumentor-content__title"> Footnotes_Config </h2> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes-config.php"><a href="files/src-includes-class-footnotes-config.html"><abbr title="src/includes/class-footnotes-config.php">class-footnotes-config.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">27</span> </aside> <p class="phpdocumentor-summary">Class defining plugin constants.</p> <section class="phpdocumentor-description"><p>This class contains no methods of properties.</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">subpackage</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>includes</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> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">todo</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Remove.</p> </section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">deprecated</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <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 -constant -public"> <a href="classes/Footnotes-Config.html#constant_C_STR_LOVE_SYMBOL">C_STR_LOVE_SYMBOL</a> <span> = '<span style="color:#ff6d3b; font-weight:bold;">&hearts;</span>' </span> </dt> <dd>HTML element for the ‘love’ symbol.</dd> <dt class="phpdocumentor-table-of-contents__entry -constant -public"> <a href="classes/Footnotes-Config.html#constant_C_STR_LOVE_SYMBOL_HEADING">C_STR_LOVE_SYMBOL_HEADING</a> <span> = '<span class="footnotes_heart_heading">&hearts;</span>' </span> </dt> <dd>HTML element for the ‘love’ symbol used in dashboard heading</dd> <dt class="phpdocumentor-table-of-contents__entry -constant -public"> <a href="classes/Footnotes-Config.html#constant_C_STR_NO_LOVE_SLUG">C_STR_NO_LOVE_SLUG</a> <span> = '[[no footnotes: love]]' </span> </dt> <dd>Shortcode to NOT display the ‘LOVE ME’ slug on certain pages.</dd> <dt class="phpdocumentor-table-of-contents__entry -constant -public"> <a href="classes/Footnotes-Config.html#constant_C_STR_PLUGIN_HEADING_NAME">C_STR_PLUGIN_HEADING_NAME</a> <span> = '<span class="footnotes_logo_heading footnotes_logo_part1_heading">foot</span><span class="footnotes_logo_heading footnotes_logo_part2_heading">notes</span>' </span> </dt> <dd>Public plugin name for use as a dashboard heading.</dd> <dt class="phpdocumentor-table-of-contents__entry -constant -public"> <a href="classes/Footnotes-Config.html#constant_C_STR_PLUGIN_PUBLIC_NAME">C_STR_PLUGIN_PUBLIC_NAME</a> <span> = '<span class="footnotes_logo footnotes_logo_part1">foot</span><span class="footnotes_logo footnotes_logo_part2">notes</span>' </span> </dt> <dd>Public plugin name.</dd> </dl> <section class="phpdocumentor-constants"> <h3 class="phpdocumentor-elements__header" id="constants"> Constants <a href="classes/Footnotes-Config.html#constants" class="headerlink"><i class="fas fa-link"></i></a> </h3> <article class="phpdocumentor-element -constant -public -deprecated"> <h4 class="phpdocumentor-element__name" id="constant_C_STR_LOVE_SYMBOL"> C_STR_LOVE_SYMBOL <a href="classes/Footnotes-Config.html#constant_C_STR_LOVE_SYMBOL" 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/class-footnotes-config.php"><a href="files/src-includes-class-footnotes-config.html"><abbr title="src/includes/class-footnotes-config.php">class-footnotes-config.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">65</span> </aside> <p class="phpdocumentor-summary">HTML element for the ‘love’ symbol.</p> <code class="phpdocumentor-signature phpdocumentor-code -deprecated"> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__type">string</span> <span class="phpdocumentor-signature__name">C_STR_LOVE_SYMBOL</span> = <span class="phpdocumentor-signature__default-value">'<span style="color:#ff6d3b; font-weight:bold;">&hearts;</span>'</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"></section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">todo</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Remove.</p> </section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">deprecated</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"></section> </dd> </dl> </article> <article class="phpdocumentor-element -constant -public -deprecated"> <h4 class="phpdocumentor-element__name" id="constant_C_STR_LOVE_SYMBOL_HEADING"> C_STR_LOVE_SYMBOL_HEADING <a href="classes/Footnotes-Config.html#constant_C_STR_LOVE_SYMBOL_HEADING" 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/class-footnotes-config.php"><a href="files/src-includes-class-footnotes-config.html"><abbr title="src/includes/class-footnotes-config.php">class-footnotes-config.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">76</span> </aside> <p class="phpdocumentor-summary">HTML element for the ‘love’ symbol used in dashboard heading</p> <code class="phpdocumentor-signature phpdocumentor-code -deprecated"> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__type">string</span> <span class="phpdocumentor-signature__name">C_STR_LOVE_SYMBOL_HEADING</span> = <span class="phpdocumentor-signature__default-value">'<span class="footnotes_heart_heading">&hearts;</span>'</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">2.0.4</span> <section class="phpdocumentor-description"></section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">todo</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Remove.</p> </section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">deprecated</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"></section> </dd> </dl> </article> <article class="phpdocumentor-element -constant -public -deprecated"> <h4 class="phpdocumentor-element__name" id="constant_C_STR_NO_LOVE_SLUG"> C_STR_NO_LOVE_SLUG <a href="classes/Footnotes-Config.html#constant_C_STR_NO_LOVE_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/class-footnotes-config.php"><a href="files/src-includes-class-footnotes-config.html"><abbr title="src/includes/class-footnotes-config.php">class-footnotes-config.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">87</span> </aside> <p class="phpdocumentor-summary">Shortcode to NOT display the ‘LOVE ME’ slug on certain pages.</p> <code class="phpdocumentor-signature phpdocumentor-code -deprecated"> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__type">string</span> <span class="phpdocumentor-signature__name">C_STR_NO_LOVE_SLUG</span> = <span class="phpdocumentor-signature__default-value">'[[no footnotes: love]]'</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"></section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">todo</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Remove.</p> </section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">deprecated</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"></section> </dd> </dl> </article> <article class="phpdocumentor-element -constant -public -deprecated"> <h4 class="phpdocumentor-element__name" id="constant_C_STR_PLUGIN_HEADING_NAME"> C_STR_PLUGIN_HEADING_NAME <a href="classes/Footnotes-Config.html#constant_C_STR_PLUGIN_HEADING_NAME" 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/class-footnotes-config.php"><a href="files/src-includes-class-footnotes-config.html"><abbr title="src/includes/class-footnotes-config.php">class-footnotes-config.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">54</span> </aside> <p class="phpdocumentor-summary">Public plugin name for use as a dashboard heading.</p> <code class="phpdocumentor-signature phpdocumentor-code -deprecated"> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__type">string</span> <span class="phpdocumentor-signature__name">C_STR_PLUGIN_HEADING_NAME</span> = <span class="phpdocumentor-signature__default-value">'<span class="footnotes_logo_heading footnotes_logo_part1_heading">foot</span><span class="footnotes_logo_heading footnotes_logo_part2_heading">notes</span>'</span> </code> <section class="phpdocumentor-description"><p>After properly displaying in dashboard headings until WPv5.4, the above started in WP 5.5 being torn apart as if the headline was <code class="prettyprint">text-align:justify</code> and not the last line. That ugly display bug badly affected the plugin's communication. The only working solution found so far is using <code class="prettyprint">position:fixed</code> in one heading that isn't translated, and dropping the logo in another, translatable heading.</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">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">2.0.4</span> <section class="phpdocumentor-description"></section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">todo</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Remove.</p> </section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">deprecated</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"></section> </dd> </dl> </article> <article class="phpdocumentor-element -constant -public -deprecated"> <h4 class="phpdocumentor-element__name" id="constant_C_STR_PLUGIN_PUBLIC_NAME"> C_STR_PLUGIN_PUBLIC_NAME <a href="classes/Footnotes-Config.html#constant_C_STR_PLUGIN_PUBLIC_NAME" 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/class-footnotes-config.php"><a href="files/src-includes-class-footnotes-config.html"><abbr title="src/includes/class-footnotes-config.php">class-footnotes-config.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">37</span> </aside> <p class="phpdocumentor-summary">Public plugin name.</p> <code class="phpdocumentor-signature phpdocumentor-code -deprecated"> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__type">string</span> <span class="phpdocumentor-signature__name">C_STR_PLUGIN_PUBLIC_NAME</span> = <span class="phpdocumentor-signature__default-value">'<span class="footnotes_logo footnotes_logo_part1">foot</span><span class="footnotes_logo footnotes_logo_part2">notes</span>'</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"></section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">todo</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>Remove.</p> </section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">deprecated</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"></section> </dd> </dl> </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> <a href="classes/Footnotes-Config.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a> </main> <script> cssVars({}); </script> </body> </html>