Rumperuu/footnotes
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
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/footnotes-includes-Loader.html

857 lines
46 KiB
HTML
Raw Normal View History

docs: update documentation
2021-05-01 20:39:33 +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">
docs: update documentation
2021-08-10 18:31:57 +00:00
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
docs: update documentation
2021-05-01 20:39:33 +00:00
<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" />
docs: update documentation
2021-08-10 18:31:57 +00:00
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
docs: update documentation
2021-05-01 20:39:33 +00:00
<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="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">
docs: update documentation
2021-08-10 18:31:57 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
docs: update documentation
2021-08-10 18:31:57 +00:00
<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>
docs: update documentation
2021-05-01 20:39:33 +00:00
<ul class="phpdocumentor-list">
<li><a href="namespaces/footnotes-admin.html"><abbr title="\footnotes\admin">admin</abbr></a></li>
<li><a href="namespaces/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
<li><a href="namespaces/footnotes-general.html"><abbr title="\footnotes\general">general</abbr></a></li>
</ul>
</section>
docs: update documentation
2021-05-02 20:27:53 +00:00
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
docs: update documentation
2021-08-10 18:31:57 +00:00
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
docs: update documentation
2021-05-02 20:27:53 +00:00
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
docs: update documentation
2021-05-01 20:39:33 +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">
<li class="phpdocumentor-breadcrumb"><a href="namespaces/footnotes.html">footnotes</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/footnotes-includes.html">includes</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
Loader
docs: update documentation
2021-05-02 20:27:53 +00:00
<div class="phpdocumentor-element__package">
in package
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="packages/footnotes.html">footnotes</a></li>
</ul>
</div>
docs: update documentation
2021-05-01 20:39:33 +00:00
</h2>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-loader.php"><a href="files/src-includes-class-loader.html"><abbr title="src/includes/class-loader.php">class-loader.php</abbr></a></abbr>
:
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">25</span>
docs: update documentation
2021-08-10 18:31:57 +00:00
</aside>
docs: update documentation
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">Class defining action/filter registration for the plugin.</p>
<section class="phpdocumentor-description"><p>Maintain a list of all hooks that are registered throughout the plugin, and
register them with the WordPress API. Call the run function to execute the
list of actions and filters.</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.8.0</span>
docs: update documentation
2021-08-10 18:31:57 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
</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 -property -protected">
<a href="classes/footnotes-includes-Loader.html#property_actions">$actions</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>The array of actions registered with WordPress.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/footnotes-includes-Loader.html#property_filters">$filters</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>The array of filters registered with WordPress.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-Loader.html#method___construct">__construct()</a>
<span>
docs: update documentation
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
docs: update documentation
2021-05-01 20:39:33 +00:00
</dt>
<dd>Initialize the collections used to maintain the actions and filters.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-Loader.html#method_add_action">add_action()</a>
<span>
docs: update documentation
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
docs: update documentation
2021-05-01 20:39:33 +00:00
</dt>
<dd>Add a new action to the collection to be registered with WordPress.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-Loader.html#method_add_filter">add_filter()</a>
<span>
docs: update documentation
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
docs: update documentation
2021-05-01 20:39:33 +00:00
</dt>
<dd>Add a new filter to the collection to be registered with WordPress.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-includes-Loader.html#method_run">run()</a>
<span>
docs: update documentation
2021-05-02 20:27:53 +00:00
&nbsp;: void </span>
docs: update documentation
2021-05-01 20:39:33 +00:00
</dt>
<dd>Registers the filters and actions with WordPress.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/footnotes-includes-Loader.html#method_add">add()</a>
<span>
docs: update documentation
2021-05-02 20:27:53 +00:00
&nbsp;: array&lt;string|int, array&lt;string|int, string|int|object&gt;&gt; </span>
docs: update documentation
2021-05-01 20:39:33 +00:00
</dt>
<dd>A utility function that is used to register the actions and hooks into a single
collection.</dd>
</dl>
<section class="phpdocumentor-properties">
<h3 class="phpdocumentor-elements__header" id="properties">
Properties
<a href="classes/footnotes-includes-Loader.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_actions">
$actions
<a href="classes/footnotes-includes-Loader.html#property_actions" 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="src/includes/class-loader.php"><a href="files/src-includes-class-loader.html"><abbr title="src/includes/class-loader.php">class-loader.php</abbr></a></abbr>
:
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">34</span>
docs: update documentation
2021-08-10 18:31:57 +00:00
</aside>
docs: update documentation
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">The array of actions registered with WordPress.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">$actions</span>
</code>
docs: update documentation
2021-08-10 18:31:57 +00:00
<section class="phpdocumentor-description"><p>The actions registered with WordPress to fire when the plugin loads.</p>
</section>
docs: update documentation
2021-05-01 20:39:33 +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">
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-tag__name">since</span>
docs: update documentation
2021-05-01 20:39:33 +00:00
</dt>
<dd class="phpdocumentor-tag-list__definition">
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-tag-link">2.8.0</span>
docs: update documentation
2021-05-01 20:39:33 +00:00
docs: update documentation
2021-08-10 18:31:57 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
</dd>
<dt class="phpdocumentor-tag-list__entry">
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-tag__name">see</span>
docs: update documentation
2021-05-01 20:39:33 +00:00
</dt>
<dd class="phpdocumentor-tag-list__definition">
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-tag-link"><a href="classes/footnotes-includes-Loader.html#method_add"><abbr title="\footnotes\includes\Loader::add()">Loader::add()</abbr></a></span>
<section class="phpdocumentor-description"><p>For more information on the hook array format.</p>
</section>
docs: update documentation
2021-05-01 20:39:33 +00:00
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_filters">
$filters
<a href="classes/footnotes-includes-Loader.html#property_filters" 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="src/includes/class-loader.php"><a href="files/src-includes-class-loader.html"><abbr title="src/includes/class-loader.php">class-loader.php</abbr></a></abbr>
:
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">44</span>
docs: update documentation
2021-08-10 18:31:57 +00:00
</aside>
docs: update documentation
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">The array of filters registered with WordPress.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">$filters</span>
</code>
docs: update documentation
2021-08-10 18:31:57 +00:00
<section class="phpdocumentor-description"><p>The filters registered with WordPress to fire when the plugin loads.</p>
</section>
docs: update documentation
2021-05-01 20:39:33 +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">
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-tag__name">since</span>
docs: update documentation
2021-05-01 20:39:33 +00:00
</dt>
<dd class="phpdocumentor-tag-list__definition">
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-tag-link">2.8.0</span>
docs: update documentation
2021-05-01 20:39:33 +00:00
docs: update documentation
2021-08-10 18:31:57 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
</dd>
<dt class="phpdocumentor-tag-list__entry">
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-tag__name">see</span>
docs: update documentation
2021-05-01 20:39:33 +00:00
</dt>
<dd class="phpdocumentor-tag-list__definition">
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-tag-link"><a href="classes/footnotes-includes-Loader.html#method_add"><abbr title="\footnotes\includes\Loader::add()">Loader::add()</abbr></a></span>
<section class="phpdocumentor-description"><p>For more information on the hook array format.</p>
</section>
docs: update documentation
2021-05-01 20:39:33 +00:00
</dd>
</dl>
</article>
</section>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/footnotes-includes-Loader.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/footnotes-includes-Loader.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="src/includes/class-loader.php"><a href="files/src-includes-class-loader.html"><abbr title="src/includes/class-loader.php">class-loader.php</abbr></a></abbr>
:
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">53</span>
docs: update documentation
2021-08-10 18:31:57 +00:00
</aside>
docs: update documentation
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">Initialize the collections used to maintain the actions and filters.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
docs: update documentation
2021-05-01 20:39:33 +00:00
docs: update documentation
2021-08-10 18:31:57 +00:00
docs: update documentation
2021-05-01 20:39:33 +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">
<span class="phpdocumentor-tag-link">2.8.0</span>
docs: update documentation
2021-08-10 18:31:57 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
docs: update documentation
2021-05-01 20:39:33 +00:00
&mdash;
docs: update documentation
2021-08-10 18:31:57 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_add_action">
add_action()
<a href="classes/footnotes-includes-Loader.html#method_add_action" 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-loader.php"><a href="files/src-includes-class-loader.html"><abbr title="src/includes/class-loader.php">class-loader.php</abbr></a></abbr>
:
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">73</span>
docs: update documentation
2021-08-10 18:31:57 +00:00
</aside>
docs: update documentation
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">Add a new action to the collection to be registered with WordPress.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">add_action</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$hook</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">object&nbsp;</span><span class="phpdocumentor-signature__argument__name">$component</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$callback</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$priority</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">10</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$accepted_args</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">1</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
docs: update documentation
2021-05-01 20:39:33 +00:00
docs: update documentation
2021-08-10 18:31:57 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
<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">$hook</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The name of the WordPress action that is being registered.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$component</span>
: <span class="phpdocumentor-signature__argument__return-type">object</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>A reference to the instance of the object on which the action is defined.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$callback</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The name of the function definition on the <code class="prettyprint">$component</code>.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$priority</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">10</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
docs: update documentation
2021-05-02 20:27:53 +00:00
<section class="phpdocumentor-description"><p>Optional. The priority at which the function should be fired. Default is 10.</p>
docs: update documentation
2021-05-01 20:39:33 +00:00
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$accepted_args</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">1</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
docs: update documentation
2021-05-02 20:27:53 +00:00
<section class="phpdocumentor-description"><p>Optional. The number of arguments that should be passed to the $callback. Default is 1.</p>
docs: update documentation
2021-05-01 20:39:33 +00:00
</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.8.0</span>
docs: update documentation
2021-08-10 18:31:57 +00:00
docs: update documentation
2021-05-02 20:27:53 +00:00
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/footnotes-includes-Loader.html#method_add"><abbr title="\footnotes\includes\Loader::add()">Loader::add()</abbr></a></span>
<section class="phpdocumentor-description"><p>For more information on the hook array format.</p>
</section>
docs: update documentation
2021-05-01 20:39:33 +00:00
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
docs: update documentation
2021-05-01 20:39:33 +00:00
&mdash;
docs: update documentation
2021-08-10 18:31:57 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_add_filter">
add_filter()
<a href="classes/footnotes-includes-Loader.html#method_add_filter" 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-loader.php"><a href="files/src-includes-class-loader.html"><abbr title="src/includes/class-loader.php">class-loader.php</abbr></a></abbr>
:
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">90</span>
docs: update documentation
2021-08-10 18:31:57 +00:00
</aside>
docs: update documentation
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">Add a new filter to the collection to be registered with WordPress.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">add_filter</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$hook</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">object&nbsp;</span><span class="phpdocumentor-signature__argument__name">$component</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$callback</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$priority</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">10</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$accepted_args</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">1</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
docs: update documentation
2021-05-01 20:39:33 +00:00
docs: update documentation
2021-08-10 18:31:57 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
<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">$hook</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The name of the WordPress filter that is being registered.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$component</span>
: <span class="phpdocumentor-signature__argument__return-type">object</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>A reference to the instance of the object on which the filter is defined.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$callback</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The name of the function definition on the <code class="prettyprint">$component</code>.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$priority</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">10</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
docs: update documentation
2021-05-02 20:27:53 +00:00
<section class="phpdocumentor-description"><p>Optional. The priority at which the function should be fired. Default is 10.</p>
docs: update documentation
2021-05-01 20:39:33 +00:00
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$accepted_args</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">1</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
docs: update documentation
2021-05-02 20:27:53 +00:00
<section class="phpdocumentor-description"><p>Optional. The number of arguments that should be passed to the $callback. Default is 1.</p>
docs: update documentation
2021-05-01 20:39:33 +00:00
</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.8.0</span>
docs: update documentation
2021-08-10 18:31:57 +00:00
docs: update documentation
2021-05-02 20:27:53 +00:00
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/footnotes-includes-Loader.html#method_add"><abbr title="\footnotes\includes\Loader::add()">Loader::add()</abbr></a></span>
<section class="phpdocumentor-description"><p>For more information on the hook array format.</p>
</section>
docs: update documentation
2021-05-01 20:39:33 +00:00
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
docs: update documentation
2021-05-01 20:39:33 +00:00
&mdash;
docs: update documentation
2021-08-10 18:31:57 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_run">
run()
<a href="classes/footnotes-includes-Loader.html#method_run" 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-loader.php"><a href="files/src-includes-class-loader.html"><abbr title="src/includes/class-loader.php">class-loader.php</abbr></a></abbr>
:
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">102</span>
docs: update documentation
2021-08-10 18:31:57 +00:00
</aside>
docs: update documentation
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">Registers the filters and actions with WordPress.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">run</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
docs: update documentation
2021-05-01 20:39:33 +00:00
docs: update documentation
2021-08-10 18:31:57 +00:00
docs: update documentation
2021-05-01 20:39:33 +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">
<span class="phpdocumentor-tag-link">2.8.0</span>
docs: update documentation
2021-08-10 18:31:57 +00:00
docs: update documentation
2021-05-02 20:27:53 +00:00
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/footnotes-includes-Loader.html#method_add"><abbr title="\footnotes\includes\Loader::add()">Loader::add()</abbr></a></span>
<section class="phpdocumentor-description"><p>For more information on the hook array format.</p>
</section>
docs: update documentation
2021-05-01 20:39:33 +00:00
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">void</span>
docs: update documentation
2021-05-01 20:39:33 +00:00
&mdash;
docs: update documentation
2021-08-10 18:31:57 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_add">
add()
<a href="classes/footnotes-includes-Loader.html#method_add" 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-loader.php"><a href="files/src-includes-class-loader.html"><abbr title="src/includes/class-loader.php">class-loader.php</abbr></a></abbr>
:
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">135</span>
docs: update documentation
2021-08-10 18:31:57 +00:00
</aside>
docs: update documentation
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">A utility function that is used to register the actions and hooks into a single
collection.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">add</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, array&lt;string|int, string|int|object&gt;&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$hooks</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$hook</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">object&nbsp;</span><span class="phpdocumentor-signature__argument__name">$component</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$callback</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$priority</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$accepted_args</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, array&lt;string|int, string|int|object&gt;&gt;</span></code>
docs: update documentation
2021-05-01 20:39:33 +00:00
docs: update documentation
2021-08-10 18:31:57 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
<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">$hooks</span>
docs: update documentation
2021-05-02 20:27:53 +00:00
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, array&lt;string|int, string|int|object&gt;&gt;</span>
docs: update documentation
2021-05-01 20:39:33 +00:00
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The collection of hooks that is being registered (that is, actions or filters).</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$hook</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The name of the WordPress filter that is being registered.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$component</span>
: <span class="phpdocumentor-signature__argument__return-type">object</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>A reference to the instance of the object on which the filter is defined.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$callback</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The name of the function definition on the <code class="prettyprint">$component</code>.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$priority</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The priority at which the function should be fired.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$accepted_args</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The number of arguments that should be passed to the <code class="prettyprint">$callback</code>.</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.8.0</span>
docs: update documentation
2021-08-10 18:31:57 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__response_type">array&lt;string|int, array&lt;string|int, string|int|object&gt;&gt;</span>
docs: update documentation
2021-05-01 20:39:33 +00:00
&mdash;
docs: update documentation
2021-05-02 20:27:53 +00:00
<section class="phpdocumentor-description"><p>{
The registered hook(s).</p>
<pre class="prettyprint"><code class="prettyprint">@type string $hook The name of the registered WordPress hook.
@type object $component A reference to the instance of the object on which the hook is defined.
@type string $callback The name of the function definition on the `$component`.
@type int $priority The priority at which the function should be fired.
@type int $accepted_args The number of arguments that should be passed to the `$callback`.
</code></pre>
<p>}</p>
docs: update documentation
2021-05-01 20:39:33 +00:00
</section>
</article>
</section>
docs: update documentation
2021-08-10 18:31:57 +00:00
<script type="text/javascript">
function loadExternalCodeSnippets(line) {
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
var src = pre.getAttribute('data-src').replace( /\\/g, '/');
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
var language = 'php';
var code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
}
else if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
}
else {
code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
}
}
};
xhr.send(null);
});
}
var modals = document.querySelectorAll("[data-modal]");
modals.forEach(function (trigger) {
trigger.addEventListener("click", function (event) {
//event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippets(trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
</script>
docs: update documentation
2021-05-01 20:39:33 +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="classes/footnotes-includes-Loader.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
docs: update documentation
2021-08-10 18:31:57 +00:00
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
docs: update documentation
2021-05-01 20:39:33 +00:00
</body>
</html>
Reference in a new issue Copy permalink