mirror of
https://gh.wpcy.net/https://github.com/mainwp/mainwp.dev.git
synced 2026-07-16 08:33:08 +08:00
2094 lines
106 KiB
HTML
2094 lines
106 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>MainWP Dashboard 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 rel="preconnect" href="https://fonts.gstatic.com">
|
|
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;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">
|
|
<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" />
|
|
<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">
|
|
<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/template.js"></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">MainWP Dashboard 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 -three phpdocumentor-sidebar">
|
|
<section class="phpdocumentor-sidebar__category -namespaces">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="namespaces/mainwp.html" class="">MainWP</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="namespaces/mainwp-dashboard.html" class="">Dashboard</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
</section>
|
|
<section class="phpdocumentor-sidebar__category -packages">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPDashboard.html" class="">MainWPDashboard</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPAPIManagerKeyHandler.html" class="">MainWPAPIManagerKeyHandler</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPMainWP.html" class="">MainWPMainWP</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="packages/MainWPMainWP-API.html" class="">API</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/MainWPMainWP-Keys.html" class="">Keys</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/MainWPMainWP-Client.html" class="">Client</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPAPIManagerUpdateHandler.html" class="">MainWPAPIManagerUpdateHandler</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPMainWPAPIManager.html" class="">MainWPMainWPAPIManager</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWP.html" class="">MainWP</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="packages/MainWP-Dashboard.html" class="">Dashboard</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/MainWP-DashboardMainWPsitesclientlist.html" class="">DashboardMainWPsitesclientlist</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/MainWP-DashboardThisclasshandlesthe.html" class="">DashboardThisclasshandlesthe</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/MainWP-DashboardMainWPsitesmonitoringlist.html" class="">DashboardMainWPsitesmonitoringlist</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/MainWP-DashboardCheckforpremiumpluginupdates.html" class="">DashboardCheckforpremiumpluginupdates</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPSettings.html" class="">MainWPSettings</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPBackups.html" class="">MainWPBackups</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="packages/MainWPBackups-Continue.html" class="">Continue</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPBootstrap.html" class="">MainWPBootstrap</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPUpdates.html" class="">MainWPUpdates</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="packages/MainWPUpdates-Check.html" class="">Check</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/MainWPUpdates-Overview.html" class="">Overview</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPPingChilds.html" class="">MainWPPingChilds</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPStats.html" class="">MainWPStats</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPExtensions.html" class="">MainWPExtensions</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPSecurtiy.html" class="">MainWPSecurtiy</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="packages/MainWPSecurtiy-Issues.html" class="">Issues</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPSetup.html" class="">MainWPSetup</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="packages/MainWPSetup-Wizard.html" class="">Wizard</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPSite.html" class="">MainWPSite</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="packages/MainWPSite-Open.html" class="">Open</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPThemes.html" class="">MainWPThemes</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPUser.html" class="">MainWPUser</a>
|
|
</h4>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPWidget.html" class="">MainWPWidget</a>
|
|
</h4>
|
|
<ul class="phpdocumentor-list">
|
|
<li>
|
|
<a href="packages/MainWPWidget-Mainwp.html" class="">Mainwp</a>
|
|
|
|
</li>
|
|
<li>
|
|
<a href="packages/MainWPWidget-Recent.html" class="">Recent</a>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
<a href="packages/MainWPPlugins.html" class="">MainWPPlugins</a>
|
|
</h4>
|
|
|
|
</section>
|
|
|
|
<section class="phpdocumentor-sidebar__category -reports">
|
|
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="graphs/classes.html">Class Diagram</a></h3>
|
|
<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 -indices">
|
|
<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 -nine phpdocumentor-content">
|
|
<section>
|
|
<h2>Documentation</h2>
|
|
|
|
|
|
|
|
<h3 id="toc">
|
|
Table of Contents
|
|
<a href="namespaces/default.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h3>
|
|
|
|
<h4 id="packages">
|
|
Packages
|
|
<a href="namespaces/default.html#packages" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/MainWPDashboard.html"><abbr title="\MainWPDashboard">MainWPDashboard</abbr></a></dt>
|
|
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/MainWPAPIManagerKeyHandler.html"><abbr title="\MainWPAPIManagerKeyHandler">MainWPAPIManagerKeyHandler</abbr></a></dt>
|
|
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/MainWPMainWP.html"><abbr title="\MainWPMainWP">MainWPMainWP</abbr></a></dt>
|
|
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/MainWPAPIManagerUpdateHandler.html"><abbr title="\MainWPAPIManagerUpdateHandler">MainWPAPIManagerUpdateHandler</abbr></a></dt>
|
|
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/MainWPMainWPAPIManager.html"><abbr title="\MainWPMainWPAPIManager">MainWPMainWPAPIManager</abbr></a></dt>
|
|
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/MainWP.html"><abbr title="\MainWP">MainWP</abbr></a></dt>
|
|
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/MainWPSettings.html"><abbr title="\MainWPSettings">MainWPSettings</abbr></a></dt>
|
|
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/MainWPBackups.html"><abbr title="\MainWPBackups">MainWPBackups</abbr></a></dt>
|
|
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/MainWPBootstrap.html"><abbr title="\MainWPBootstrap">MainWPBootstrap</abbr></a></dt>
|
|
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/MainWPUpdates.html"><abbr title="\MainWPUpdates">MainWPUpdates</abbr></a></dt>
|
|
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/MainWPPingChilds.html"><abbr title="\MainWPPingChilds">MainWPPingChilds</abbr></a></dt>
|
|
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/MainWPStats.html"><abbr title="\MainWPStats">MainWPStats</abbr></a></dt>
|
|
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/MainWPExtensions.html"><abbr title="\MainWPExtensions">MainWPExtensions</abbr></a></dt>
|
|
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/MainWPSecurtiy.html"><abbr title="\MainWPSecurtiy">MainWPSecurtiy</abbr></a></dt>
|
|
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/MainWPSetup.html"><abbr title="\MainWPSetup">MainWPSetup</abbr></a></dt>
|
|
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/MainWPSite.html"><abbr title="\MainWPSite">MainWPSite</abbr></a></dt>
|
|
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/MainWPThemes.html"><abbr title="\MainWPThemes">MainWPThemes</abbr></a></dt>
|
|
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/MainWPUser.html"><abbr title="\MainWPUser">MainWPUser</abbr></a></dt>
|
|
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/MainWPWidget.html"><abbr title="\MainWPWidget">MainWPWidget</abbr></a></dt>
|
|
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/MainWPPlugins.html"><abbr title="\MainWPPlugins">MainWPPlugins</abbr></a></dt>
|
|
</dl>
|
|
|
|
<h4 id="namespaces">
|
|
Namespaces
|
|
<a href="namespaces/default.html#namespaces" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -namespace"><a href="namespaces/mainwp.html"><abbr title="\MainWP">MainWP</abbr></a></dt>
|
|
</dl>
|
|
|
|
|
|
<h4 id="toc-classes">
|
|
Classes
|
|
<a href="namespaces/default.html#toc-classes" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MainWP-DateTime.html"><abbr title="\MainWP_DateTime">MainWP_DateTime</abbr></a></dt><dd>Datetime class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MainWP-Setup.html"><abbr title="\MainWP_Setup">MainWP_Setup</abbr></a></dt><dd>MainWP Setup Class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MainWP-DB.html"><abbr title="\MainWP_DB">MainWP_DB</abbr></a></dt><dd>MainWP Database Compatible class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MainWP-Extensions-View.html"><abbr title="\MainWP_Extensions_View">MainWP_Extensions_View</abbr></a></dt><dd>MainWP Extensions View Compatible class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MainWP-REST-Authentication.html"><abbr title="\MainWP_REST_Authentication">MainWP_REST_Authentication</abbr></a></dt><dd>REST API authentication class.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MainWP-Rest-Server.html"><abbr title="\MainWP_Rest_Server">MainWP_Rest_Server</abbr></a></dt><dd>Class responsible for loading the REST API and all REST API namespaces.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MainWP-Rest-Clients-Controller.html"><abbr title="\MainWP_Rest_Clients_Controller">MainWP_Rest_Clients_Controller</abbr></a></dt><dd>Class MainWP_Rest_Clients_Controller</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MainWP-REST-Controller.html"><abbr title="\MainWP_REST_Controller">MainWP_REST_Controller</abbr></a></dt><dd>Abstract Rest Controller Class</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MainWP-Rest-Global-Batch-Controller.html"><abbr title="\MainWP_Rest_Global_Batch_Controller">MainWP_Rest_Global_Batch_Controller</abbr></a></dt><dd>Class MainWP_Rest_Global_Batch_Controller</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MainWP-Rest-Sites-Controller.html"><abbr title="\MainWP_Rest_Sites_Controller">MainWP_Rest_Sites_Controller</abbr></a></dt><dd>Class MainWP_Rest_Sites_Controller</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MainWP-Rest-Tags-Controller.html"><abbr title="\MainWP_Rest_Tags_Controller">MainWP_Rest_Tags_Controller</abbr></a></dt><dd>Class MainWP_Rest_Tags_Controller</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MainWP-Rest-Updates-Controller.html"><abbr title="\MainWP_Rest_Updates_Controller">MainWP_Rest_Updates_Controller</abbr></a></dt><dd>Class MainWP_Rest_Updates_Controller</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MainWP-Rest-Costs-Controller.html"><abbr title="\MainWP_Rest_Costs_Controller">MainWP_Rest_Costs_Controller</abbr></a></dt><dd>Class MainWP_Rest_Costs_Controller</dd> </dl>
|
|
|
|
|
|
|
|
<h4 id="toc-constants">
|
|
Constants
|
|
<a href="namespaces/default.html#toc-constants" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a class="" href="namespaces/default.html#constant_DOING_CRON">DOING_CRON</a>
|
|
<span>
|
|
= \true </span>
|
|
</dt>
|
|
<dd>Checks whether cron is in progress.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a class="" href="namespaces/default.html#constant_FILTER_SANITIZE_STRING_COMPATIBLE">FILTER_SANITIZE_STRING_COMPATIBLE</a>
|
|
<span>
|
|
= 513 </span>
|
|
</dt>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a class="" href="namespaces/default.html#constant_FS_METHOD">FS_METHOD</a>
|
|
<span>
|
|
= 'direct' </span>
|
|
</dt>
|
|
<dd>Define WordPress File system.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a class="" href="namespaces/default.html#constant_MAINWP_DEMO_MODE">MAINWP_DEMO_MODE</a>
|
|
<span>
|
|
= true </span>
|
|
</dt>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a class="" href="namespaces/default.html#constant_MAINWP_MODULE_API_BACKUPS_ENABLED">MAINWP_MODULE_API_BACKUPS_ENABLED</a>
|
|
<span>
|
|
= \true </span>
|
|
</dt>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a class="" href="namespaces/default.html#constant_MAINWP_MODULE_COST_TRACKER_ENABLED">MAINWP_MODULE_COST_TRACKER_ENABLED</a>
|
|
<span>
|
|
= \true </span>
|
|
</dt>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a class="" href="namespaces/default.html#constant_MAINWP_MODULE_LOG_ENABLED">MAINWP_MODULE_LOG_ENABLED</a>
|
|
<span>
|
|
= \true </span>
|
|
</dt>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a class="" href="namespaces/default.html#constant_MAINWP_MODULES_DIR">MAINWP_MODULES_DIR</a>
|
|
<span>
|
|
= \MAINWP_PLUGIN_DIR . 'modules' . \DIRECTORY_SEPARATOR </span>
|
|
</dt>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a class="" href="namespaces/default.html#constant_MAINWP_MODULES_URL">MAINWP_MODULES_URL</a>
|
|
<span>
|
|
= \MAINWP_PLUGIN_URL . 'modules/' </span>
|
|
</dt>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a class="" href="namespaces/default.html#constant_MAINWP_PLUGIN_DIR">MAINWP_PLUGIN_DIR</a>
|
|
<span>
|
|
= \plugin_dir_path(\MAINWP_PLUGIN_FILE) </span>
|
|
</dt>
|
|
<dd>Define MainWP Dashboard Plugin Directory.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a class="" href="namespaces/default.html#constant_MAINWP_PLUGIN_FILE">MAINWP_PLUGIN_FILE</a>
|
|
<span>
|
|
= __FILE__ </span>
|
|
</dt>
|
|
<dd>Define MainWP Dashboard Plugin absolute full path and filename of this file.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a class="" href="namespaces/default.html#constant_MAINWP_PLUGIN_URL">MAINWP_PLUGIN_URL</a>
|
|
<span>
|
|
= \plugin_dir_url(\MAINWP_PLUGIN_FILE) </span>
|
|
</dt>
|
|
<dd>Define MainWP Child Dashboard URL.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a class="" href="namespaces/default.html#constant_MAINWP_REST_API_DOING">MAINWP_REST_API_DOING</a>
|
|
<span>
|
|
= true </span>
|
|
</dt>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a class="" href="namespaces/default.html#constant_MAINWP_VERSION">MAINWP_VERSION</a>
|
|
<span>
|
|
= $this->current_version </span>
|
|
</dt>
|
|
<dd>Defines MainWP Version.</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<h4 id="toc-functions">
|
|
Functions
|
|
<a href="namespaces/default.html#toc-functions" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
<a class="" href="namespaces/default.html#function_array_key_first">array_key_first()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
<a class="" href="namespaces/default.html#function_mainwp_api_hash">mainwp_api_hash()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>API - Hash.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
<a class="" href="namespaces/default.html#function_mainwp_rest_prepare_date_response">mainwp_rest_prepare_date_response()</a>
|
|
<span>
|
|
: string|null </span>
|
|
</dt>
|
|
<dd>Parses and formats a date for ISO8601/RFC3339.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
<a class="" href="namespaces/default.html#function_mainwp_string_to_bool">mainwp_string_to_bool()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Converts a string (e.g. 'yes' or 'no') to a bool.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
<a class="" href="namespaces/default.html#function_mainwp_rest_urlencode_rfc3986">mainwp_rest_urlencode_rfc3986()</a>
|
|
<span>
|
|
: string|array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd>Encodes a value according to RFC 3986.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
<a class="" href="namespaces/default.html#function_mainwp_search_in_array">mainwp_search_in_array()</a>
|
|
<span>
|
|
: array<string|int, mixed> </span>
|
|
</dt>
|
|
<dd>Method mainwp_search_in_array().</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
<a class="" href="namespaces/default.html#function_mainwpdir">mainwpdir()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Grab MainWP Directory</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
<a class="" href="namespaces/default.html#function_mainwp_do_not_have_permissions">mainwp_do_not_have_permissions()</a>
|
|
<span>
|
|
: string|bool </span>
|
|
</dt>
|
|
<dd>Detect permission level & display message to end user.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
<a class="" href="namespaces/default.html#function_mainwp_current_user_can">mainwp_current_user_can()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Check permission level.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
<a class="" href="namespaces/default.html#function_mainwp_get_actions_handler_instance">mainwp_get_actions_handler_instance()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Function to get mainwp actions handler instance.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
<a class="" href="namespaces/default.html#function_mainwp_send_json_output">mainwp_send_json_output()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Handle send json output.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
<a class="" href="namespaces/default.html#function_mainwp_modules_is_enabled">mainwp_modules_is_enabled()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Check if module is enable.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
<a class="" href="namespaces/default.html#function_mainwp_get_timestamp">mainwp_get_timestamp()</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Function mainwp_get_timestamp.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
<a class="" href="namespaces/default.html#function_mainwp_get_current_utc_datetime_db">mainwp_get_current_utc_datetime_db()</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Function mainwp_get_current_utc_datetime_db.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
<a class="" href="namespaces/default.html#function_mainwp_secure_request">mainwp_secure_request()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Function mainwp_secure_request.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
<a class="" href="namespaces/default.html#function_mainwp_autoload">mainwp_autoload()</a>
|
|
<span>
|
|
: <abbr title="\require_once">require_once</abbr> </span>
|
|
</dt>
|
|
<dd>Autoloader for all classes, pages & widgets</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
<a class="" href="namespaces/default.html#function_mainwp_module_log_filter_var">mainwp_module_log_filter_var()</a>
|
|
<span>
|
|
: <abbr title="\Returns">Returns</abbr> </span>
|
|
</dt>
|
|
<dd>Filters a variable with a specified filter.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
|
<a class="" href="namespaces/default.html#function_mainwp_module_log_get_iso_8601_extended_date">mainwp_module_log_get_iso_8601_extended_date()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Converts a time into an ISO 8601 extended formatted string.</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
<section class="phpdocumentor-constants">
|
|
<h3 class="phpdocumentor-elements__header" id="constants">
|
|
Constants
|
|
<a href="namespaces/default.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_DOING_CRON">
|
|
DOING_CRON
|
|
<a href="namespaces/default.html#constant_DOING_CRON" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="cron/bootstrap.php"><a href="files/cron-bootstrap.html"><abbr title="cron/bootstrap.php">bootstrap.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">29</span>
|
|
|
|
<a href="index.html#source-view.29" class="phpdocumentor-element-found-in__source" data-line="29" data-modal="source-view" data-src="files/cron/bootstrap.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Checks whether cron is in progress.</p>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">DOING_CRON</span>
|
|
= <span class="phpdocumentor-signature__default-value">\true</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="namespaces/default.html#constant_DOING_CRON#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">const</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>( bool ) Default: true</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">source</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_FILTER_SANITIZE_STRING_COMPATIBLE">
|
|
FILTER_SANITIZE_STRING_COMPATIBLE
|
|
<a href="namespaces/default.html#constant_FILTER_SANITIZE_STRING_COMPATIBLE" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/functions.php"><a href="files/includes-functions.html"><abbr title="includes/functions.php">functions.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">11</span>
|
|
|
|
<a href="index.html#source-view.11" class="phpdocumentor-element-found-in__source" data-line="11" data-modal="source-view" data-src="files/includes/functions.php.txt"></a>
|
|
</aside>
|
|
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">FILTER_SANITIZE_STRING_COMPATIBLE</span>
|
|
= <span class="phpdocumentor-signature__default-value">513</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_FS_METHOD">
|
|
FS_METHOD
|
|
<a href="namespaces/default.html#constant_FS_METHOD" 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/class-mainwp-system-utility.php"><a href="files/class-class-mainwp-system-utility.html"><abbr title="class/class-mainwp-system-utility.php">class-mainwp-system-utility.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">562</span>
|
|
|
|
<a href="index.html#source-view.562" class="phpdocumentor-element-found-in__source" data-line="562" data-modal="source-view" data-src="files/class/class-mainwp-system-utility.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Define WordPress File system.</p>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">FS_METHOD</span>
|
|
= <span class="phpdocumentor-signature__default-value">'direct'</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="namespaces/default.html#constant_FS_METHOD#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">const</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>( bool ) Default: true</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">source</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_MAINWP_DEMO_MODE">
|
|
MAINWP_DEMO_MODE
|
|
<a href="namespaces/default.html#constant_MAINWP_DEMO_MODE" 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/class-mainwp-system.php"><a href="files/class-class-mainwp-system.html"><abbr title="class/class-mainwp-system.php">class-mainwp-system.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">170</span>
|
|
|
|
<a href="index.html#source-view.170" class="phpdocumentor-element-found-in__source" data-line="170" data-modal="source-view" data-src="files/class/class-mainwp-system.php.txt"></a>
|
|
</aside>
|
|
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">MAINWP_DEMO_MODE</span>
|
|
= <span class="phpdocumentor-signature__default-value">true</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_MAINWP_MODULE_API_BACKUPS_ENABLED">
|
|
MAINWP_MODULE_API_BACKUPS_ENABLED
|
|
<a href="namespaces/default.html#constant_MAINWP_MODULE_API_BACKUPS_ENABLED" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="mainwp.php"><a href="files/mainwp.html">mainwp.php</a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">71</span>
|
|
|
|
<a href="index.html#source-view.71" class="phpdocumentor-element-found-in__source" data-line="71" data-modal="source-view" data-src="files/mainwp.php.txt"></a>
|
|
</aside>
|
|
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">MAINWP_MODULE_API_BACKUPS_ENABLED</span>
|
|
= <span class="phpdocumentor-signature__default-value">\true</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_MAINWP_MODULE_COST_TRACKER_ENABLED">
|
|
MAINWP_MODULE_COST_TRACKER_ENABLED
|
|
<a href="namespaces/default.html#constant_MAINWP_MODULE_COST_TRACKER_ENABLED" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="mainwp.php"><a href="files/mainwp.html">mainwp.php</a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">67</span>
|
|
|
|
<a href="index.html#source-view.67" class="phpdocumentor-element-found-in__source" data-line="67" data-modal="source-view" data-src="files/mainwp.php.txt"></a>
|
|
</aside>
|
|
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">MAINWP_MODULE_COST_TRACKER_ENABLED</span>
|
|
= <span class="phpdocumentor-signature__default-value">\true</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_MAINWP_MODULE_LOG_ENABLED">
|
|
MAINWP_MODULE_LOG_ENABLED
|
|
<a href="namespaces/default.html#constant_MAINWP_MODULE_LOG_ENABLED" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="mainwp.php"><a href="files/mainwp.html">mainwp.php</a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">63</span>
|
|
|
|
<a href="index.html#source-view.63" class="phpdocumentor-element-found-in__source" data-line="63" data-modal="source-view" data-src="files/mainwp.php.txt"></a>
|
|
</aside>
|
|
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">MAINWP_MODULE_LOG_ENABLED</span>
|
|
= <span class="phpdocumentor-signature__default-value">\true</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_MAINWP_MODULES_DIR">
|
|
MAINWP_MODULES_DIR
|
|
<a href="namespaces/default.html#constant_MAINWP_MODULES_DIR" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="mainwp.php"><a href="files/mainwp.html">mainwp.php</a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">51</span>
|
|
|
|
<a href="index.html#source-view.51" class="phpdocumentor-element-found-in__source" data-line="51" data-modal="source-view" data-src="files/mainwp.php.txt"></a>
|
|
</aside>
|
|
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">MAINWP_MODULES_DIR</span>
|
|
= <span class="phpdocumentor-signature__default-value">\MAINWP_PLUGIN_DIR . 'modules' . \DIRECTORY_SEPARATOR</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_MAINWP_MODULES_URL">
|
|
MAINWP_MODULES_URL
|
|
<a href="namespaces/default.html#constant_MAINWP_MODULES_URL" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="mainwp.php"><a href="files/mainwp.html">mainwp.php</a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">55</span>
|
|
|
|
<a href="index.html#source-view.55" class="phpdocumentor-element-found-in__source" data-line="55" data-modal="source-view" data-src="files/mainwp.php.txt"></a>
|
|
</aside>
|
|
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">MAINWP_MODULES_URL</span>
|
|
= <span class="phpdocumentor-signature__default-value">\MAINWP_PLUGIN_URL . 'modules/'</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_MAINWP_PLUGIN_DIR">
|
|
MAINWP_PLUGIN_DIR
|
|
<a href="namespaces/default.html#constant_MAINWP_PLUGIN_DIR" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="mainwp.php"><a href="files/mainwp.html">mainwp.php</a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">36</span>
|
|
|
|
<a href="index.html#source-view.36" class="phpdocumentor-element-found-in__source" data-line="36" data-modal="source-view" data-src="files/mainwp.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Define MainWP Dashboard Plugin Directory.</p>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">MAINWP_PLUGIN_DIR</span>
|
|
= <span class="phpdocumentor-signature__default-value">\plugin_dir_path(\MAINWP_PLUGIN_FILE)</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="namespaces/default.html#constant_MAINWP_PLUGIN_DIR#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">const</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>( string ) Defined MainWP Dashboard Plugin Directory.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">source</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_MAINWP_PLUGIN_FILE">
|
|
MAINWP_PLUGIN_FILE
|
|
<a href="namespaces/default.html#constant_MAINWP_PLUGIN_FILE" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="mainwp.php"><a href="files/mainwp.html">mainwp.php</a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">26</span>
|
|
|
|
<a href="index.html#source-view.26" class="phpdocumentor-element-found-in__source" data-line="26" data-modal="source-view" data-src="files/mainwp.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Define MainWP Dashboard Plugin absolute full path and filename of this file.</p>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">MAINWP_PLUGIN_FILE</span>
|
|
= <span class="phpdocumentor-signature__default-value">__FILE__</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="namespaces/default.html#constant_MAINWP_PLUGIN_FILE#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">const</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>( string ) Defined MainWP dashboard file path.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">source</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_MAINWP_PLUGIN_URL">
|
|
MAINWP_PLUGIN_URL
|
|
<a href="namespaces/default.html#constant_MAINWP_PLUGIN_URL" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="mainwp.php"><a href="files/mainwp.html">mainwp.php</a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">46</span>
|
|
|
|
<a href="index.html#source-view.46" class="phpdocumentor-element-found-in__source" data-line="46" data-modal="source-view" data-src="files/mainwp.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Define MainWP Child Dashboard URL.</p>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">MAINWP_PLUGIN_URL</span>
|
|
= <span class="phpdocumentor-signature__default-value">\plugin_dir_url(\MAINWP_PLUGIN_FILE)</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="namespaces/default.html#constant_MAINWP_PLUGIN_URL#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">const</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>( string ) Defined MainWP Dashboard Plugin URL.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">source</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_MAINWP_REST_API_DOING">
|
|
MAINWP_REST_API_DOING
|
|
<a href="namespaces/default.html#constant_MAINWP_REST_API_DOING" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/rest-api/class-mainwp-rest-authentication.php"><a href="files/includes-rest-api-class-mainwp-rest-authentication.html"><abbr title="includes/rest-api/class-mainwp-rest-authentication.php">class-mainwp-rest-authentication.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">847</span>
|
|
|
|
<a href="index.html#source-view.847" class="phpdocumentor-element-found-in__source" data-line="847" data-modal="source-view" data-src="files/includes/rest-api/class-mainwp-rest-authentication.php.txt"></a>
|
|
</aside>
|
|
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">MAINWP_REST_API_DOING</span>
|
|
= <span class="phpdocumentor-signature__default-value">true</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_MAINWP_VERSION">
|
|
MAINWP_VERSION
|
|
<a href="namespaces/default.html#constant_MAINWP_VERSION" 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/class-mainwp-system.php"><a href="files/class-class-mainwp-system.html"><abbr title="class/class-mainwp-system.php">class-mainwp-system.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">166</span>
|
|
|
|
<a href="index.html#source-view.166" class="phpdocumentor-element-found-in__source" data-line="166" data-modal="source-view" data-src="files/class/class-mainwp-system.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Defines MainWP Version.</p>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">MAINWP_VERSION</span>
|
|
= <span class="phpdocumentor-signature__default-value">$this->current_version</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="namespaces/default.html#constant_MAINWP_VERSION#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">const</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
<section class="phpdocumentor-description"><p>( string )</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-tag-list__entry">
|
|
<span class="phpdocumentor-tag__name">source</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
</article>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-functions">
|
|
<h3 class="phpdocumentor-elements__header" id="functions">
|
|
Functions
|
|
<a href="namespaces/default.html#functions" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h3>
|
|
<article class="phpdocumentor-element -function - ">
|
|
<h4 class="phpdocumentor-element__name" id="function_array_key_first">
|
|
array_key_first()
|
|
<a href="namespaces/default.html#function_array_key_first" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/compatible.php"><a href="files/includes-compatible.html"><abbr title="includes/compatible.php">compatible.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">177</span>
|
|
|
|
<a href="index.html#source-view.177" class="phpdocumentor-element-found-in__source" data-line="177" data-modal="source-view" data-src="files/includes/compatible.php.txt"></a>
|
|
</aside>
|
|
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility"></span>
|
|
<span class="phpdocumentor-signature__name">array_key_first</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">$arr</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
|
|
<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">$arr</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -function - ">
|
|
<h4 class="phpdocumentor-element__name" id="function_mainwp_api_hash">
|
|
mainwp_api_hash()
|
|
<a href="namespaces/default.html#function_mainwp_api_hash" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/core-functions.php"><a href="files/includes-core-functions.html"><abbr title="includes/core-functions.php">core-functions.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">18</span>
|
|
|
|
<a href="index.html#source-view.18" class="phpdocumentor-element-found-in__source" data-line="18" data-modal="source-view" data-src="files/includes/core-functions.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">API - Hash.</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility"></span>
|
|
<span class="phpdocumentor-signature__name">mainwp_api_hash</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$data</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
|
|
|
|
|
<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">$data</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Message to be hashed.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="namespaces/default.html#function_mainwp_api_hash#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">5.2</span>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">string</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -function - ">
|
|
<h4 class="phpdocumentor-element__name" id="function_mainwp_rest_prepare_date_response">
|
|
mainwp_rest_prepare_date_response()
|
|
<a href="namespaces/default.html#function_mainwp_rest_prepare_date_response" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/core-functions.php"><a href="files/includes-core-functions.html"><abbr title="includes/core-functions.php">core-functions.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">33</span>
|
|
|
|
<a href="index.html#source-view.33" class="phpdocumentor-element-found-in__source" data-line="33" data-modal="source-view" data-src="files/includes/core-functions.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Parses and formats a date for ISO8601/RFC3339.</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility"></span>
|
|
<span class="phpdocumentor-signature__name">mainwp_rest_prepare_date_response</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string|null|<abbr title="\DateTime">DateTime</abbr> </span><span class="phpdocumentor-signature__argument__name">$date</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$utc</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">true</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|null</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>Required WP 4.4 or later.
|
|
See https://developer.wordpress.org/reference/functions/mysql_to_rfc3339/</p>
|
|
</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">$date</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string|null|<abbr title="\DateTime">DateTime</abbr></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Date.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$utc</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">true</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Send false to get local/offset time.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="namespaces/default.html#function_mainwp_rest_prepare_date_response#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">5.2</span>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">string|null</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>ISO8601/RFC3339 formatted datetime.</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -function - ">
|
|
<h4 class="phpdocumentor-element__name" id="function_mainwp_string_to_bool">
|
|
mainwp_string_to_bool()
|
|
<a href="namespaces/default.html#function_mainwp_string_to_bool" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/core-functions.php"><a href="files/includes-core-functions.html"><abbr title="includes/core-functions.php">core-functions.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">59</span>
|
|
|
|
<a href="index.html#source-view.59" class="phpdocumentor-element-found-in__source" data-line="59" data-modal="source-view" data-src="files/includes/core-functions.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Converts a string (e.g. 'yes' or 'no') to a bool.</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility"></span>
|
|
<span class="phpdocumentor-signature__name">mainwp_string_to_bool</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string|bool </span><span class="phpdocumentor-signature__argument__name">$str</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
|
|
<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">$str</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string|bool</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>String to convert. If a bool is passed it will be returned as-is.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="namespaces/default.html#function_mainwp_string_to_bool#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">5.2</span>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -function - ">
|
|
<h4 class="phpdocumentor-element__name" id="function_mainwp_rest_urlencode_rfc3986">
|
|
mainwp_rest_urlencode_rfc3986()
|
|
<a href="namespaces/default.html#function_mainwp_rest_urlencode_rfc3986" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/core-functions.php"><a href="files/includes-core-functions.html"><abbr title="includes/core-functions.php">core-functions.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">72</span>
|
|
|
|
<a href="index.html#source-view.72" class="phpdocumentor-element-found-in__source" data-line="72" data-modal="source-view" data-src="files/includes/core-functions.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Encodes a value according to RFC 3986.</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility"></span>
|
|
<span class="phpdocumentor-signature__name">mainwp_rest_urlencode_rfc3986</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string|array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|array<string|int, mixed></span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>Supports multidimensional arrays.</p>
|
|
</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">$value</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string|array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>The value to encode.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="namespaces/default.html#function_mainwp_rest_urlencode_rfc3986#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.6.0</span>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">string|array<string|int, mixed></span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Encoded values.</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -function - ">
|
|
<h4 class="phpdocumentor-element__name" id="function_mainwp_search_in_array">
|
|
mainwp_search_in_array()
|
|
<a href="namespaces/default.html#function_mainwp_search_in_array" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/core-functions.php"><a href="files/includes-core-functions.html"><abbr title="includes/core-functions.php">core-functions.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">90</span>
|
|
|
|
<a href="index.html#source-view.90" class="phpdocumentor-element-found-in__source" data-line="90" data-modal="source-view" data-src="files/includes/core-functions.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Method mainwp_search_in_array().</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility"></span>
|
|
<span class="phpdocumentor-signature__name">mainwp_search_in_array</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">$data</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$search_str</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$params</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">array()</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, mixed></span></code>
|
|
|
|
|
|
<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">$data</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>The data.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$search_str</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>search string.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$params</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">array()</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>params.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, mixed></span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Search result.</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -function - ">
|
|
<h4 class="phpdocumentor-element__name" id="function_mainwpdir">
|
|
mainwpdir()
|
|
<a href="namespaces/default.html#function_mainwpdir" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/functions.php"><a href="files/includes-functions.html"><abbr title="includes/functions.php">functions.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">21</span>
|
|
|
|
<a href="index.html#source-view.21" class="phpdocumentor-element-found-in__source" data-line="21" data-modal="source-view" data-src="files/includes/functions.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Grab MainWP Directory</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility"></span>
|
|
<span class="phpdocumentor-signature__name">mainwpdir</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">string</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -function - ">
|
|
<h4 class="phpdocumentor-element__name" id="function_mainwp_do_not_have_permissions">
|
|
mainwp_do_not_have_permissions()
|
|
<a href="namespaces/default.html#function_mainwp_do_not_have_permissions" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/functions.php"><a href="files/includes-functions.html"><abbr title="includes/functions.php">functions.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">36</span>
|
|
|
|
<a href="index.html#source-view.36" class="phpdocumentor-element-found-in__source" data-line="36" data-modal="source-view" data-src="files/includes/functions.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Detect permission level & display message to end user.</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility"></span>
|
|
<span class="phpdocumentor-signature__name">mainwp_do_not_have_permissions</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$where</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">''</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$echo_out</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">true</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|bool</span></code>
|
|
|
|
|
|
<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">$where</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">''</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>User's location.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$echo_out</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">true</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Defines weather or not to echo error message.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">string|bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>$msg|false</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -function - ">
|
|
<h4 class="phpdocumentor-element__name" id="function_mainwp_current_user_can">
|
|
mainwp_current_user_can()
|
|
<a href="namespaces/default.html#function_mainwp_current_user_can" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/functions.php"><a href="files/includes-functions.html"><abbr title="includes/functions.php">functions.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">60</span>
|
|
|
|
<a href="index.html#source-view.60" class="phpdocumentor-element-found-in__source" data-line="60" data-modal="source-view" data-src="files/includes/functions.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Check permission level.</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility"></span>
|
|
<span class="phpdocumentor-signature__name">mainwp_current_user_can</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$cap_type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">''</span><span> ]</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">$cap</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">''</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>To compatible with extensions.</p>
|
|
</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">$cap_type</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">''</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Group or type of capabilities.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$cap</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">''</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Capabilities for current user.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>true|false</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -function - ">
|
|
<h4 class="phpdocumentor-element__name" id="function_mainwp_get_actions_handler_instance">
|
|
mainwp_get_actions_handler_instance()
|
|
<a href="namespaces/default.html#function_mainwp_get_actions_handler_instance" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/functions.php"><a href="files/includes-functions.html"><abbr title="includes/functions.php">functions.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">75</span>
|
|
|
|
<a href="index.html#source-view.75" class="phpdocumentor-element-found-in__source" data-line="75" data-modal="source-view" data-src="files/includes/functions.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Function to get mainwp actions handler instance.</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility"></span>
|
|
<span class="phpdocumentor-signature__name">mainwp_get_actions_handler_instance</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>true|false</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -function - ">
|
|
<h4 class="phpdocumentor-element__name" id="function_mainwp_send_json_output">
|
|
mainwp_send_json_output()
|
|
<a href="namespaces/default.html#function_mainwp_send_json_output" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/functions.php"><a href="files/includes-functions.html"><abbr title="includes/functions.php">functions.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">86</span>
|
|
|
|
<a href="index.html#source-view.86" class="phpdocumentor-element-found-in__source" data-line="86" data-modal="source-view" data-src="files/includes/functions.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Handle send json output.</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility"></span>
|
|
<span class="phpdocumentor-signature__name">mainwp_send_json_output</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">$output</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
|
|
<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">$output</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>Array output.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -function - ">
|
|
<h4 class="phpdocumentor-element__name" id="function_mainwp_modules_is_enabled">
|
|
mainwp_modules_is_enabled()
|
|
<a href="namespaces/default.html#function_mainwp_modules_is_enabled" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/functions.php"><a href="files/includes-functions.html"><abbr title="includes/functions.php">functions.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">104</span>
|
|
|
|
<a href="index.html#source-view.104" class="phpdocumentor-element-found-in__source" data-line="104" data-modal="source-view" data-src="files/includes/functions.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Check if module is enable.</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility"></span>
|
|
<span class="phpdocumentor-signature__name">mainwp_modules_is_enabled</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$module</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
|
|
|
|
|
|
<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">$module</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>module slug.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>true|false</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -function - ">
|
|
<h4 class="phpdocumentor-element__name" id="function_mainwp_get_timestamp">
|
|
mainwp_get_timestamp()
|
|
<a href="namespaces/default.html#function_mainwp_get_timestamp" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/functions.php"><a href="files/includes-functions.html"><abbr title="includes/functions.php">functions.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">122</span>
|
|
|
|
<a href="index.html#source-view.122" class="phpdocumentor-element-found-in__source" data-line="122" data-modal="source-view" data-src="files/includes/functions.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Function mainwp_get_timestamp.</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility"></span>
|
|
<span class="phpdocumentor-signature__name">mainwp_get_timestamp</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$add_time</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">0</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
|
|
|
|
|
|
<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">$add_time</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">0</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>add time.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">int</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -function - ">
|
|
<h4 class="phpdocumentor-element__name" id="function_mainwp_get_current_utc_datetime_db">
|
|
mainwp_get_current_utc_datetime_db()
|
|
<a href="namespaces/default.html#function_mainwp_get_current_utc_datetime_db" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/functions.php"><a href="files/includes-functions.html"><abbr title="includes/functions.php">functions.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">137</span>
|
|
|
|
<a href="index.html#source-view.137" class="phpdocumentor-element-found-in__source" data-line="137" data-modal="source-view" data-src="files/includes/functions.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Function mainwp_get_current_utc_datetime_db.</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility"></span>
|
|
<span class="phpdocumentor-signature__name">mainwp_get_current_utc_datetime_db</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$get_db_datetime</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">true</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
|
|
|
|
|
|
<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">$get_db_datetime</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">true</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>To get db datetime.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">int</span>
|
|
</section>
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -function - ">
|
|
<h4 class="phpdocumentor-element__name" id="function_mainwp_secure_request">
|
|
mainwp_secure_request()
|
|
<a href="namespaces/default.html#function_mainwp_secure_request" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="includes/functions.php"><a href="files/includes-functions.html"><abbr title="includes/functions.php">functions.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">151</span>
|
|
|
|
<a href="index.html#source-view.151" class="phpdocumentor-element-found-in__source" data-line="151" data-modal="source-view" data-src="files/includes/functions.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Function mainwp_secure_request.</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility"></span>
|
|
<span class="phpdocumentor-signature__name">mainwp_secure_request</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$action</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
|
|
|
|
|
<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">$action</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>request action.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -function - ">
|
|
<h4 class="phpdocumentor-element__name" id="function_mainwp_autoload">
|
|
mainwp_autoload()
|
|
<a href="namespaces/default.html#function_mainwp_autoload" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="mainwp.php"><a href="files/mainwp.html">mainwp.php</a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">86</span>
|
|
|
|
<a href="index.html#source-view.86" class="phpdocumentor-element-found-in__source" data-line="86" data-modal="source-view" data-src="files/mainwp.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Autoloader for all classes, pages & widgets</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility"></span>
|
|
<span class="phpdocumentor-signature__name">mainwp_autoload</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$class_name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\require_once">require_once</abbr></span></code>
|
|
|
|
|
|
<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">$class_name</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Folder name class|pages|widgets.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type"><abbr title="\require_once">require_once</abbr></span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>$autoload_path;</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -function - ">
|
|
<h4 class="phpdocumentor-element__name" id="function_mainwp_module_log_filter_var">
|
|
mainwp_module_log_filter_var()
|
|
<a href="namespaces/default.html#function_mainwp_module_log_filter_var" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="modules/logs/includes/functions.php"><a href="files/modules-logs-includes-functions.html"><abbr title="modules/logs/includes/functions.php">functions.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">20</span>
|
|
|
|
<a href="index.html#source-view.20" class="phpdocumentor-element-found-in__source" data-line="20" data-modal="source-view" data-src="files/modules/logs/includes/functions.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Filters a variable with a specified filter.</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility"></span>
|
|
<span class="phpdocumentor-signature__name">mainwp_module_log_filter_var</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$var_value</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$filter</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$options</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">array()</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\Returns">Returns</abbr></span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>This is a polyfill function intended to be used in place of PHP's
|
|
filter_var() function, which can occasionally be unreliable.</p>
|
|
</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">$var_value</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Value to filter.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$filter</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>The ID of the filter to apply.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$options</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">array()</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Associative array of options or bitwise disjunction of flags. If filter accepts options, flags can be provided in "flags" field of array. For the "callback" filter, callable type should be passed. The callback must accept one argument, the value to be filtered, and return the value after filtering/sanitizing it.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type"><abbr title="\Returns">Returns</abbr></span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>the filtered data, or FALSE if the filter fails.</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -function - ">
|
|
<h4 class="phpdocumentor-element__name" id="function_mainwp_module_log_get_iso_8601_extended_date">
|
|
mainwp_module_log_get_iso_8601_extended_date()
|
|
<a href="namespaces/default.html#function_mainwp_module_log_get_iso_8601_extended_date" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="modules/logs/includes/functions.php"><a href="files/modules-logs-includes-functions.html"><abbr title="modules/logs/includes/functions.php">functions.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">33</span>
|
|
|
|
<a href="index.html#source-view.33" class="phpdocumentor-element-found-in__source" data-line="33" data-modal="source-view" data-src="files/modules/logs/includes/functions.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Converts a time into an ISO 8601 extended formatted string.</p>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility"></span>
|
|
<span class="phpdocumentor-signature__name">mainwp_module_log_get_iso_8601_extended_date</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">int|bool </span><span class="phpdocumentor-signature__argument__name">$time</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$offset</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">0</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
|
|
|
|
|
<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">$time</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int|bool</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">false</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Seconds since unix epoch.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$offset</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
= <span class="phpdocumentor-signature__argument__default-value">0</span> </dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>Timezone offset.</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">string</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>an ISO 8601 extended formatted time</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
</section>
|
|
|
|
</section>
|
|
</div>
|
|
<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>
|
|
<a href="index.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
|
|
|
|
</main>
|
|
|
|
<script>
|
|
cssVars({});
|
|
</script>
|
|
<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>
|
|
</body>
|
|
</html>
|
