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-admin-layout-Init.html

821 lines
38 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-09 10:27:33 +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-09 10:27:33 +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-09 10:27:33 +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-09 10:27:33 +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-09 10:27:33 +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-admin.html">admin</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/footnotes-admin-layout.html">layout</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
Init
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/admin/layout/class-init.php"><a href="files/src-admin-layout-class-init.html"><abbr title="src/admin/layout/class-init.php">class-init.php</abbr></a></abbr>
:
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">28</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
</aside>
docs: update documentation
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">Class to initialise all defined page layouts.</p>
<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>
docs: update documentation
2021-08-09 10:27:33 +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 -constant -public">
docs: update documentation
2021-05-02 20:27:53 +00:00
<a href="classes/footnotes-admin-layout-Init.html#constant_MAIN_MENU_SLUG">MAIN_MENU_SLUG</a>
docs: update documentation
2021-05-01 20:39:33 +00:00
<span>
&nbsp;= &#039;footnotes&#039; </span>
</dt>
<dd>Slug for the Plugin main menu.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
docs: update documentation
2021-08-09 10:27:33 +00:00
<a href="classes/footnotes-admin-layout-Init.html#property_plugin_name">$plugin_name</a>
<span>
&nbsp;: string </span>
</dt>
<dd>The ID of this plugin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
docs: update documentation
2021-05-02 20:27:53 +00:00
<a href="classes/footnotes-admin-layout-Init.html#property_settings">$settings</a>
docs: update documentation
2021-05-01 20:39:33 +00:00
<span>
docs: update documentation
2021-08-09 10:27:33 +00:00
&nbsp;: <a href="classes/footnotes-includes-Settings.html"><abbr title="\footnotes\includes\Settings">Settings</abbr></a> </span>
</dt>
<dd>The plugin settings object.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/footnotes-admin-layout-Init.html#property_settings_page">$settings_page</a>
<span>
&nbsp;: <a href="classes/footnotes-admin-layout-SettingsPage.html"><abbr title="\footnotes\admin\layout\SettingsPage">SettingsPage</abbr></a> </span>
docs: update documentation
2021-05-01 20:39:33 +00:00
</dt>
<dd>Contains the settings page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-layout-Init.html#method___construct">__construct()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Initializes all WordPress hooks for the Plugin Settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-layout-Init.html#method_get_plugin_meta_information">get_plugin_meta_information()</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>AJAX call. returns a JSON string containing meta information about a specific WordPress Plugin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-layout-Init.html#method_initialize_settings">initialize_settings()</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 settings and initialises the settings page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-layout-Init.html#method_register_options_submenu">register_options_submenu()</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 footnotes submenu page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/footnotes-admin-layout-Init.html#method_load_dependencies">load_dependencies()</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>Load the required dependencies for the layouts pages.</dd>
</dl>
<section class="phpdocumentor-constants">
<h3 class="phpdocumentor-elements__header" id="constants">
Constants
<a href="classes/footnotes-admin-layout-Init.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article class="phpdocumentor-element -constant -public ">
docs: update documentation
2021-05-02 20:27:53 +00:00
<h4 class="phpdocumentor-element__name" id="constant_MAIN_MENU_SLUG">
MAIN_MENU_SLUG
<a href="classes/footnotes-admin-layout-Init.html#constant_MAIN_MENU_SLUG" class="headerlink"><i class="fas fa-link"></i></a>
docs: update documentation
2021-05-01 20:39:33 +00:00
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-init.php"><a href="files/src-admin-layout-class-init.html"><abbr title="src/admin/layout/class-init.php">class-init.php</abbr></a></abbr>
:
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">37</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
</aside>
docs: update documentation
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">Slug for the Plugin main menu.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">MAIN_MENU_SLUG</span>
docs: update documentation
2021-05-01 20:39:33 +00:00
= <span class="phpdocumentor-signature__default-value">&#039;footnotes&#039;</span>
</code>
docs: update documentation
2021-08-09 10:27:33 +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">1.5.0</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
</dd>
</dl>
</article>
</section>
<section class="phpdocumentor-properties">
<h3 class="phpdocumentor-elements__header" id="properties">
Properties
<a href="classes/footnotes-admin-layout-Init.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="
phpdocumentor-element
-property
-private
"
docs: update documentation
2021-08-09 10:27:33 +00:00
>
<h4 class="phpdocumentor-element__name" id="property_plugin_name">
$plugin_name
<a href="classes/footnotes-admin-layout-Init.html#property_plugin_name" 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/admin/layout/class-init.php"><a href="files/src-admin-layout-class-init.html"><abbr title="src/admin/layout/class-init.php">class-init.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">63</span>
</aside>
<p class="phpdocumentor-summary">The ID of this plugin.</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">$plugin_name</span>
</code>
<section class="phpdocumentor-description"><p>The ID of this plugin.</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">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>private</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.8.0</span>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
docs: update documentation
2021-05-01 20:39:33 +00:00
>
docs: update documentation
2021-05-02 20:27:53 +00:00
<h4 class="phpdocumentor-element__name" id="property_settings">
$settings
<a href="classes/footnotes-admin-layout-Init.html#property_settings" class="headerlink"><i class="fas fa-link"></i></a>
docs: update documentation
2021-05-01 20:39:33 +00:00
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-init.php"><a href="files/src-admin-layout-class-init.html"><abbr title="src/admin/layout/class-init.php">class-init.php</abbr></a></abbr>
:
docs: update documentation
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-element-found-in__line">71</span>
docs: update documentation
2021-05-01 20:39:33 +00:00
docs: update documentation
2021-08-09 10:27:33 +00:00
</aside>
<p class="phpdocumentor-summary">The plugin settings object.</p>
docs: update documentation
2021-05-01 20:39:33 +00:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-signature__type"><a href="classes/footnotes-includes-Settings.html"><abbr title="\footnotes\includes\Settings">Settings</abbr></a></span>
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-signature__name">$settings</span>
docs: update documentation
2021-05-01 20:39:33 +00:00
</code>
docs: update documentation
2021-08-09 10:27:33 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
<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">
docs: update documentation
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-tag__name">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>private</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
docs: update documentation
2021-05-01 20:39:33 +00:00
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
docs: update documentation
2021-08-09 10:27:33 +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-09 10:27:33 +00:00
</dd>
</dl>
docs: update documentation
2021-05-01 20:39:33 +00:00
docs: update documentation
2021-08-09 10:27:33 +00:00
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_settings_page">
$settings_page
<a href="classes/footnotes-admin-layout-Init.html#property_settings_page" 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/admin/layout/class-init.php"><a href="files/src-admin-layout-class-init.html"><abbr title="src/admin/layout/class-init.php">class-init.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">46</span>
</aside>
<p class="phpdocumentor-summary">Contains the settings page.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type"><a href="classes/footnotes-admin-layout-SettingsPage.html"><abbr title="\footnotes\admin\layout\SettingsPage">SettingsPage</abbr></a></span>
<span class="phpdocumentor-signature__name">$settings_page</span>
</code>
<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>
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-admin-layout-Init.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-admin-layout-Init.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/admin/layout/class-init.php"><a href="files/src-admin-layout-class-init.html"><abbr title="src/admin/layout/class-init.php">class-init.php</abbr></a></abbr>
:
docs: update documentation
2021-05-02 20:27:53 +00:00
<span class="phpdocumentor-element-found-in__line">54</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
</aside>
docs: update documentation
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">Initializes all WordPress hooks for the Plugin Settings.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$plugin_name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/footnotes-includes-Settings.html"><abbr title="\footnotes\includes\Settings">Settings</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$settings</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
docs: update documentation
2021-05-01 20:39:33 +00:00
docs: update documentation
2021-08-09 10:27:33 +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">$plugin_name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
docs: update documentation
2021-08-09 10:27:33 +00:00
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$settings</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/footnotes-includes-Settings.html"><abbr title="\footnotes\includes\Settings">Settings</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
docs: update documentation
2021-05-01 20:39:33 +00:00
</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>
docs: update documentation
2021-08-09 10:27:33 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
</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.8.0</span>
<section class="phpdocumentor-description"><p>Added <code class="prettyprint">$plugin_name</code> parameter.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
docs: update documentation
2021-08-09 10:27:33 +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_get_plugin_meta_information">
get_plugin_meta_information()
<a href="classes/footnotes-admin-layout-Init.html#method_get_plugin_meta_information" 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/admin/layout/class-init.php"><a href="files/src-admin-layout-class-init.html"><abbr title="src/admin/layout/class-init.php">class-init.php</abbr></a></abbr>
:
docs: update documentation
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-element-found-in__line">135</span>
</aside>
docs: update documentation
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">AJAX call. returns a JSON string containing meta information about a specific WordPress Plugin.</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">get_plugin_meta_information</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-09 10:27:33 +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">1.5.0</span>
docs: update documentation
2021-08-09 10:27:33 +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-09 10:27:33 +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_initialize_settings">
initialize_settings()
<a href="classes/footnotes-admin-layout-Init.html#method_initialize_settings" 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/admin/layout/class-init.php"><a href="files/src-admin-layout-class-init.html"><abbr title="src/admin/layout/class-init.php">class-init.php</abbr></a></abbr>
:
docs: update documentation
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-element-found-in__line">102</span>
</aside>
docs: update documentation
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">Registers the settings and initialises the settings page.</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">initialize_settings</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-09 10:27:33 +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">1.5.0</span>
docs: update documentation
2021-08-09 10:27:33 +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-09 10:27:33 +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_register_options_submenu">
register_options_submenu()
<a href="classes/footnotes-admin-layout-Init.html#method_register_options_submenu" 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/admin/layout/class-init.php"><a href="files/src-admin-layout-class-init.html"><abbr title="src/admin/layout/class-init.php">class-init.php</abbr></a></abbr>
:
docs: update documentation
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-element-found-in__line">118</span>
</aside>
docs: update documentation
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">Registers the footnotes submenu page.</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">register_options_submenu</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-09 10:27:33 +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">1.5.0</span>
docs: update documentation
2021-08-09 10:27:33 +00:00
docs: update documentation
2021-05-01 20:39:33 +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="http://codex.wordpress.org/Function_Reference/add_menu_page"><abbr title="http://codex.wordpress.org/Function_Reference/add_menu_page">http://codex.wordpress.org/Function_Reference/add_menu_page</abbr></a></span>
docs: update documentation
2021-08-09 10:27:33 +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-09 10:27:33 +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_load_dependencies">
load_dependencies()
<a href="classes/footnotes-admin-layout-Init.html#method_load_dependencies" 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/admin/layout/class-init.php"><a href="files/src-admin-layout-class-init.html"><abbr title="src/admin/layout/class-init.php">class-init.php</abbr></a></abbr>
:
docs: update documentation
2021-08-09 10:27:33 +00:00
<span class="phpdocumentor-element-found-in__line">205</span>
</aside>
docs: update documentation
2021-05-01 20:39:33 +00:00
<p class="phpdocumentor-summary">Load the required dependencies for the layouts pages.</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">load_dependencies</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
<section class="phpdocumentor-description"><p>Include the following files that make up the plugin:</p>
<ul>
<li>
<a href="classes/footnotes-includes-Config.html"><abbr title="\footnotes\includes\Config">Config</abbr></a>: defines plugin constants;</li>
<li>
<a href="classes/footnotes-includes-Settings.html"><abbr title="\footnotes\includes\Settings">Settings</abbr></a>: defines configurable plugin settings; and</li>
<li>
docs: update documentation
2021-08-09 10:27:33 +00:00
<a href="classes/footnotes-includes-Settings.html"><abbr title="\footnotes\includes\Settings">Settings</abbr></a>: defines the plugin settings page.</li>
docs: update documentation
2021-05-01 20:39:33 +00:00
</ul>
</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">access</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>private</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.8.0</span>
docs: update documentation
2021-08-09 10:27:33 +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-09 10:27:33 +00:00
docs: update documentation
2021-05-01 20:39:33 +00:00
</article>
</section>
docs: update documentation
2021-08-09 10:27:33 +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-admin-layout-Init.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-09 10:27:33 +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