This repository has been archived on 2023-08-16. You can view files and clone it, but cannot push or open issues or pull requests.
footnotes/docs/classes/MCI-Footnotes-Config.html

460 lines
21 KiB
HTML
Raw Normal View History

<!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">
<li class="phpdocumentor-breadcrumb"><a href="packages/footnotes.html">footnotes</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
MCI_Footnotes_Config
</h2>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/config.php"><a href="files/class-config.html"><abbr title="class/config.php">config.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">17</span>
</aside>
<p class="phpdocumentor-summary">Contains all Plugin Constants. Contains no Method or Property.</p>
<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>
<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/MCI-Footnotes-Config.html#constant_C_STR_LOVE_SYMBOL">C_STR_LOVE_SYMBOL</a>
<span>
&nbsp;= &#039;&lt;span style=&quot;color:#ff6d3b; font-weight:bold;&quot;&gt;&amp;hearts;&lt;/span&gt;&#039; </span>
</dt>
<dd>Html tag for the LOVE symbol.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/MCI-Footnotes-Config.html#constant_C_STR_LOVE_SYMBOL_HEADING">C_STR_LOVE_SYMBOL_HEADING</a>
<span>
&nbsp;= &#039;&lt;span class=&quot;footnotes_heart_heading&quot;&gt;&amp;hearts;&lt;/span&gt;&#039; </span>
</dt>
<dd>HTML code for the &#039;love&#039; symbol used in dashboard heading</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/MCI-Footnotes-Config.html#constant_C_STR_NO_LOVE_SLUG">C_STR_NO_LOVE_SLUG</a>
<span>
&nbsp;= &#039;[[no footnotes: love]]&#039; </span>
</dt>
<dd>Short code to DON&#039;T display the &#039;LOVE ME&#039; slug on certain pages.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/MCI-Footnotes-Config.html#constant_C_STR_PLUGIN_HEADING_NAME">C_STR_PLUGIN_HEADING_NAME</a>
<span>
&nbsp;= &#039;&lt;span class=&quot;footnotes_logo_heading footnotes_logo_part1_heading&quot;&gt;foot&lt;/span&gt;&lt;span class=&quot;footnotes_logo_heading footnotes_logo_part2_heading&quot;&gt;notes&lt;/span&gt;&#039; </span>
</dt>
<dd>Public Plugin name for dashboard heading</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/MCI-Footnotes-Config.html#constant_C_STR_PLUGIN_NAME">C_STR_PLUGIN_NAME</a>
<span>
&nbsp;= &#039;footnotes&#039; </span>
</dt>
<dd>Internal Plugin name.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/MCI-Footnotes-Config.html#constant_C_STR_PLUGIN_PUBLIC_NAME">C_STR_PLUGIN_PUBLIC_NAME</a>
<span>
&nbsp;= &#039;&lt;span class=&quot;footnotes_logo footnotes_logo_part1&quot;&gt;foot&lt;/span&gt;&lt;span class=&quot;footnotes_logo footnotes_logo_part2&quot;&gt;notes&lt;/span&gt;&#039; </span>
</dt>
<dd>Public Plugin name.</dd>
</dl>
<section class="phpdocumentor-constants">
<h3 class="phpdocumentor-elements__header" id="constants">
Constants
<a href="classes/MCI-Footnotes-Config.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_C_STR_LOVE_SYMBOL">
C_STR_LOVE_SYMBOL
<a href="classes/MCI-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="class/config.php"><a href="files/class-config.html"><abbr title="class/config.php">config.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">56</span>
</aside>
<p class="phpdocumentor-summary">Html tag for the LOVE symbol.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<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">&#039;&lt;span style=&quot;color:#ff6d3b; font-weight:bold;&quot;&gt;&amp;hearts;&lt;/span&gt;&#039;</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>
</dl>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_C_STR_LOVE_SYMBOL_HEADING">
C_STR_LOVE_SYMBOL_HEADING
<a href="classes/MCI-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="class/config.php"><a href="files/class-config.html"><abbr title="class/config.php">config.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">64</span>
</aside>
<p class="phpdocumentor-summary">HTML code for the &#039;love&#039; symbol used in dashboard heading</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<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">&#039;&lt;span class=&quot;footnotes_heart_heading&quot;&gt;&amp;hearts;&lt;/span&gt;&#039;</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>
</dl>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_C_STR_NO_LOVE_SLUG">
C_STR_NO_LOVE_SLUG
<a href="classes/MCI-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="class/config.php"><a href="files/class-config.html"><abbr title="class/config.php">config.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">72</span>
</aside>
<p class="phpdocumentor-summary">Short code to DON&#039;T display the &#039;LOVE ME&#039; slug on certain pages.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<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">&#039;[[no footnotes: love]]&#039;</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>
</dl>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_C_STR_PLUGIN_HEADING_NAME">
C_STR_PLUGIN_HEADING_NAME
<a href="classes/MCI-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="class/config.php"><a href="files/class-config.html"><abbr title="class/config.php">config.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">48</span>
</aside>
<p class="phpdocumentor-summary">Public Plugin name for dashboard heading</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<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">&#039;&lt;span class=&quot;footnotes_logo_heading footnotes_logo_part1_heading&quot;&gt;foot&lt;/span&gt;&lt;span class=&quot;footnotes_logo_heading footnotes_logo_part2_heading&quot;&gt;notes&lt;/span&gt;&#039;</span>
</code>
<section class="phpdocumentor-description"><p>After properly displaying in dashboard headings until WPv5.4, the above started
in WPv5.5 being torn apart as if the headline was text-align:justify and not
the last line. That ugly display bug badly affected the plugins communication.
The only working solution found so far is using position:fixed in one heading
that isnt 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>
</dl>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_C_STR_PLUGIN_NAME">
C_STR_PLUGIN_NAME
<a href="classes/MCI-Footnotes-Config.html#constant_C_STR_PLUGIN_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="class/config.php"><a href="files/class-config.html"><abbr title="class/config.php">config.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">24</span>
</aside>
<p class="phpdocumentor-summary">Internal Plugin name.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">C_STR_PLUGIN_NAME</span>
= <span class="phpdocumentor-signature__default-value">&#039;footnotes&#039;</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>
</dl>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_C_STR_PLUGIN_PUBLIC_NAME">
C_STR_PLUGIN_PUBLIC_NAME
<a href="classes/MCI-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="class/config.php"><a href="files/class-config.html"><abbr title="class/config.php">config.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">34</span>
</aside>
<p class="phpdocumentor-summary">Public Plugin name.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<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">&#039;&lt;span class=&quot;footnotes_logo footnotes_logo_part1&quot;&gt;foot&lt;/span&gt;&lt;span class=&quot;footnotes_logo footnotes_logo_part2&quot;&gt;notes&lt;/span&gt;&#039;</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>
</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/MCI-Footnotes-Config.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
</body>
</html>