<!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_Template </h2> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="class/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">19</span> </aside> <p class="phpdocumentor-summary">Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).</p> <section class="phpdocumentor-description"><p>Loads a template file, replaces all Placeholders and returns the replaced file content.</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">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-Template.html#constant_C_STR_DASHBOARD">C_STR_DASHBOARD</a> <span> = 'dashboard' </span> </dt> <dd>Directory name for dashboard templates.</dd> <dt class="phpdocumentor-table-of-contents__entry -constant -public"> <a href="classes/MCI-Footnotes-Template.html#constant_C_STR_PUBLIC">C_STR_PUBLIC</a> <span> = 'public' </span> </dt> <dd>Directory name for public templates.</dd> <dt class="phpdocumentor-table-of-contents__entry -property -public"> <a href="classes/MCI-Footnotes-Template.html#property_plugin_directory">$plugin_directory</a> <span> : string </span> </dt> <dd>Plugin Directory</dd> <dt class="phpdocumentor-table-of-contents__entry -property -private"> <a href="classes/MCI-Footnotes-Template.html#property_a_str_original_content">$a_str_original_content</a> <span> : string </span> </dt> <dd>Contains the content of the template after initialize.</dd> <dt class="phpdocumentor-table-of-contents__entry -property -private"> <a href="classes/MCI-Footnotes-Template.html#property_a_str_replaced_content">$a_str_replaced_content</a> <span> : string </span> </dt> <dd>Contains the content of the template after initialize with replaced place holders.</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/MCI-Footnotes-Template.html#method___construct">__construct()</a> <span> : mixed </span> </dt> <dd>Class Constructor. Reads and loads the template file without replace any placeholder.</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/MCI-Footnotes-Template.html#method_get_content">get_content()</a> <span> : string </span> </dt> <dd>Returns the content of the template file with replaced placeholders.</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/MCI-Footnotes-Template.html#method_get_template">get_template()</a> <span> : mixed </span> </dt> <dd>Get the template.</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/MCI-Footnotes-Template.html#method_process_template">process_template()</a> <span> : void </span> </dt> <dd>Process template file.</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/MCI-Footnotes-Template.html#method_reload">reload()</a> <span> : mixed </span> </dt> <dd>Reloads the original content of the template file.</dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/MCI-Footnotes-Template.html#method_replace">replace()</a> <span> : bool </span> </dt> <dd>Replace all placeholders specified in array.</dd> </dl> <section class="phpdocumentor-constants"> <h3 class="phpdocumentor-elements__header" id="constants"> Constants <a href="classes/MCI-Footnotes-Template.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_DASHBOARD"> C_STR_DASHBOARD <a href="classes/MCI-Footnotes-Template.html#constant_C_STR_DASHBOARD" 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/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">27</span> </aside> <p class="phpdocumentor-summary">Directory name for dashboard templates.</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_DASHBOARD</span> = <span class="phpdocumentor-signature__default-value">'dashboard'</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_PUBLIC"> C_STR_PUBLIC <a href="classes/MCI-Footnotes-Template.html#constant_C_STR_PUBLIC" 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/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">35</span> </aside> <p class="phpdocumentor-summary">Directory name for public templates.</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_PUBLIC</span> = <span class="phpdocumentor-signature__default-value">'public'</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> <section class="phpdocumentor-properties"> <h3 class="phpdocumentor-elements__header" id="properties"> Properties <a href="classes/MCI-Footnotes-Template.html#properties" class="headerlink"><i class="fas fa-link"></i></a> </h3> <article class=" phpdocumentor-element -property -public " > <h4 class="phpdocumentor-element__name" id="property_plugin_directory"> $plugin_directory <a href="classes/MCI-Footnotes-Template.html#property_plugin_directory" class="headerlink"><i class="fas fa-link"></i></a> <span class="phpdocumentor-element__modifiers"> </span> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="class/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">60</span> </aside> <p class="phpdocumentor-summary">Plugin Directory</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__type">string</span> <span class="phpdocumentor-signature__name">$plugin_directory</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.4.0d3</span> <section class="phpdocumentor-description"></section> </dd> </dl> </article> <article class=" phpdocumentor-element -property -private " > <h4 class="phpdocumentor-element__name" id="property_a_str_original_content"> $a_str_original_content <a href="classes/MCI-Footnotes-Template.html#property_a_str_original_content" class="headerlink"><i class="fas fa-link"></i></a> <span class="phpdocumentor-element__modifiers"> </span> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="class/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">43</span> </aside> <p class="phpdocumentor-summary">Contains the content of the template after initialize.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">private</span> <span class="phpdocumentor-signature__type">string</span> <span class="phpdocumentor-signature__name">$a_str_original_content</span> = <span class="phpdocumentor-signature__default-value">''</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 -property -private " > <h4 class="phpdocumentor-element__name" id="property_a_str_replaced_content"> $a_str_replaced_content <a href="classes/MCI-Footnotes-Template.html#property_a_str_replaced_content" class="headerlink"><i class="fas fa-link"></i></a> <span class="phpdocumentor-element__modifiers"> </span> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="class/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">51</span> </aside> <p class="phpdocumentor-summary">Contains the content of the template after initialize with replaced place holders.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">private</span> <span class="phpdocumentor-signature__type">string</span> <span class="phpdocumentor-signature__name">$a_str_replaced_content</span> = <span class="phpdocumentor-signature__default-value">''</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> <section class="phpdocumentor-methods"> <h3 class="phpdocumentor-elements__header" id="methods"> Methods <a href="classes/MCI-Footnotes-Template.html#methods" class="headerlink"><i class="fas fa-link"></i></a> </h3> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method___construct"> __construct() <a href="classes/MCI-Footnotes-Template.html#method___construct" 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/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">77</span> </aside> <p class="phpdocumentor-summary">Class Constructor. Reads and loads the template file without replace any placeholder.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">__construct</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_file_type</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$p_str_file_name</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$p_str_extension</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'html'</span><span> ]</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_file_type</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Template file type (take a look on the Class constants).</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$p_str_file_name</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Template file name inside the Template directory without the file extension.</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$p_str_extension</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> = <span class="phpdocumentor-signature__argument__default-value">'html'</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Optional Template file extension (default: html).</p> <ul> <li>Adding: Templates: support for custom templates in sibling folder, thanks to @misfist issue report.</li> </ul> </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">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">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">2.2.6</span> <section class="phpdocumentor-description"></section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">reporter</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <section class="phpdocumentor-description"><p>@misfist</p> </section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">link</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <a class="phpdocumentor-tag-link" href="https://wordpress.org/support/topic/template-override-filter/"> https://wordpress.org/support/topic/template-override-filter/ </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 -public " > <h4 class="phpdocumentor-element__name" id="method_get_content"> get_content() <a href="classes/MCI-Footnotes-Template.html#method_get_content" 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/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">143</span> </aside> <p class="phpdocumentor-summary">Returns the content of the template file with replaced placeholders.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">get_content</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</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> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">string</span> — <section class="phpdocumentor-description"><p>Template content with replaced placeholders.</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_get_template"> get_template() <a href="classes/MCI-Footnotes-Template.html#method_get_template" 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/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">190</span> </aside> <p class="phpdocumentor-summary">Get the template.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">get_template</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_file_type</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$p_str_file_name</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$p_str_extension</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'html'</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code> <section class="phpdocumentor-description"><ul> <li>Adding: Templates: Enable template location stack, thanks to @misfist issue report and code contribution.</li> </ul> </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_file_type</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>The file type of the template.</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$p_str_file_name</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>The file name of the template.</p> </section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$p_str_extension</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> = <span class="phpdocumentor-signature__argument__default-value">'html'</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>The file extension of the template.</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">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">2.4.0d3</span> <section class="phpdocumentor-description"><p>Contribution.</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">2.5.0</span> <section class="phpdocumentor-description"><p>Release.</p> </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>@misfist</p> </section> </dd> <dt class="phpdocumentor-tag-list__entry"> <span class="phpdocumentor-tag__name">link</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <a class="phpdocumentor-tag-link" href="https://wordpress.org/support/topic/template-override-filter/#post-13864301"> https://wordpress.org/support/topic/template-override-filter/#post-13864301 </a> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">mixed</span> — <section class="phpdocumentor-description"><p>false | template path</p> </section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_process_template"> process_template() <a href="classes/MCI-Footnotes-Template.html#method_process_template" 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/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">161</span> </aside> <p class="phpdocumentor-summary">Process template file.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">process_template</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$template</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</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">$template</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>The template to be processed.</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">since</span> </dt> <dd class="phpdocumentor-tag-list__definition"> <span class="phpdocumentor-tag-link">2.4.0d3</span> <section class="phpdocumentor-description"></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">2.0.3</span> <section class="phpdocumentor-description"><p>Replace tab with a space.</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">2.0.3</span> <section class="phpdocumentor-description"><p>Replace 2 spaces with 1.</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">2.0.4</span> <section class="phpdocumentor-description"><p>Collapse multiple spaces.</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">2.2.6</span> <section class="phpdocumentor-description"><p>Delete a space before a closing pointy bracket.</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">2.5.4</span> <section class="phpdocumentor-description"><p>Collapse HTML comments and PHP/JS docblocks (only).</p> </section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">void</span> — <section class="phpdocumentor-description"></section> </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_reload"> reload() <a href="classes/MCI-Footnotes-Template.html#method_reload" 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/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">133</span> </aside> <p class="phpdocumentor-summary">Reloads the original content of the template file.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">reload</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"></section> </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 -public " > <h4 class="phpdocumentor-element__name" id="method_replace"> replace() <a href="classes/MCI-Footnotes-Template.html#method_replace" 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/template.php"><a href="files/class-template.html"><abbr title="class/template.php">template.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">111</span> </aside> <p class="phpdocumentor-summary">Replace all placeholders specified in array.</p> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">replace</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$p_arr_placeholders</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</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_arr_placeholders</span> : <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"><p>Placeholders (key = placeholder, value = value).</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">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">bool</span> — <section class="phpdocumentor-description"><p>True on Success, False if Placeholders invalid.</p> </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> <a href="classes/MCI-Footnotes-Template.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a> </main> <script> cssVars({}); </script> </body> </html>