mainwp/mainwp.dev
1
0
Fork 0
mirror of https://gh.wpcy.net/https://github.com/mainwp/mainwp.dev.git synced 2026-07-16 13:40:53 +08:00
Code Issues Projects Packages Activity Actions
mainwp.dev/source-code/dashboard/files/includes-functions.html
Dennis Dornon 5169eec27d Adding Pronamic WordPress Documentor for Hooks
2025-03-17 19:02:54 -04:00

968 lines
46 KiB
HTML
Raw Permalink Blame History

<!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>
<ul class="phpdocumentor-breadcrumbs">
</ul>
<article class="phpdocumentor-element -file">
<h2 class="phpdocumentor-content__title">functions.php</h2>
<p class="phpdocumentor-summary">MainWP Base Functions.</p>
<section class="phpdocumentor-description"><p>Grab MainWP Directory and check for permissions.</p>
</section>
<h3 id="toc">
Table of Contents
<a href="files/includes-functions.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-constants">
Constants
<a href="files/includes-functions.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_FILTER_SANITIZE_STRING_COMPATIBLE">FILTER_SANITIZE_STRING_COMPATIBLE</a>
<span>
&nbsp;= 513 </span>
</dt>
</dl>
<h4 id="toc-functions">
Functions
<a href="files/includes-functions.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_mainwpdir">mainwpdir()</a>
<span>
&nbsp;: 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>
&nbsp;: string|bool </span>
</dt>
<dd>Detect permission level &amp; 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>
&nbsp;: 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>
&nbsp;: 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>
&nbsp;: 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>
&nbsp;: 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>
&nbsp;: 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>
&nbsp;: 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>
&nbsp;: void </span>
</dt>
<dd>Function mainwp_secure_request.</dd>
</dl>
<section class="phpdocumentor-constants">
<h3 class="phpdocumentor-elements__header" id="constants">
Constants
<a href="files/includes-functions.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_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="files/includes-functions.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>
</section>
<section class="phpdocumentor-functions">
<h3 class="phpdocumentor-elements__header" id="functions">
Functions
<a href="files/includes-functions.html#functions" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<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="files/includes-functions.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="files/includes-functions.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 &amp; 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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$where</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</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">&#039;&#039;</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>
&mdash;
<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="files/includes-functions.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&nbsp;</span><span class="phpdocumentor-signature__argument__name">$cap_type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$cap</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</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">&#039;&#039;</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">&#039;&#039;</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>
&mdash;
<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="files/includes-functions.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>
&mdash;
<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="files/includes-functions.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&lt;string|int, mixed&gt;&nbsp;</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&lt;string|int, mixed&gt;</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="files/includes-functions.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&nbsp;</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>
&mdash;
<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="files/includes-functions.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&nbsp;</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="files/includes-functions.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&nbsp;</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="files/includes-functions.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&nbsp;</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>
</section>
<div class="phpdocumentor-modal" id="source-view">
<div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container">
<div class="phpdocumentor-modal-content">
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/includes/functions.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
</div>
<button data-exit-button class="phpdocumentor-modal__close">&times;</button>
</div>
</div>
<script type="text/javascript">
(function () {
function loadExternalCodeSnippet(el, url, line) {
Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
const language = 'php';
const code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState !== 4) {
return;
}
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
return;
}
if (xhr.status === 404) {
code.textContent = '✖ Error: File could not be found';
return;
}
if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
return;
}
code.textContent = '✖ Error: An unknown error occurred';
};
xhr.send(null);
});
}
const modalButtons = document.querySelectorAll("[data-modal]");
const openedAsLocalFile = window.location.protocol === 'file:';
if (modalButtons.length > 0 && openedAsLocalFile) {
console.warn(
'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
'browsers block XHR requests when a page is opened this way'
);
}
modalButtons.forEach(function (trigger) {
if (openedAsLocalFile) {
trigger.setAttribute("hidden", "hidden");
}
trigger.addEventListener("click", function (event) {
event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
if (!modal) {
console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
return;
}
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
})();
</script>
</article>
</section>
<section class="phpdocumentor-on-this-page__sidebar">
<section class="phpdocumentor-on-this-page__content">
<strong class="phpdocumentor-on-this-page__title">On this page</strong>
<ul class="phpdocumentor-list -clean">
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="files/includes-functions.html#toc-constants">Constants</a></li>
<li><a href="files/includes-functions.html#toc-functions">Functions</a></li>
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Constants</li>
<li>
<ul class="phpdocumentor-list -clean">
<li class=""><a href="namespaces/default.html#constant_FILTER_SANITIZE_STRING_COMPATIBLE">FILTER_SANITIZE_STRING_COMPATIBLE</a></li>
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Functions</li>
<li>
<ul class="phpdocumentor-list -clean">
<li class=""><a href="namespaces/default.html#function_mainwp_current_user_can">mainwp_current_user_can()</a></li>
<li class=""><a href="namespaces/default.html#function_mainwp_do_not_have_permissions">mainwp_do_not_have_permissions()</a></li>
<li class=""><a href="namespaces/default.html#function_mainwp_get_actions_handler_instance">mainwp_get_actions_handler_instance()</a></li>
<li class=""><a href="namespaces/default.html#function_mainwp_get_current_utc_datetime_db">mainwp_get_current_utc_datetime_db()</a></li>
<li class=""><a href="namespaces/default.html#function_mainwp_get_timestamp">mainwp_get_timestamp()</a></li>
<li class=""><a href="namespaces/default.html#function_mainwp_modules_is_enabled">mainwp_modules_is_enabled()</a></li>
<li class=""><a href="namespaces/default.html#function_mainwp_secure_request">mainwp_secure_request()</a></li>
<li class=""><a href="namespaces/default.html#function_mainwp_send_json_output">mainwp_send_json_output()</a></li>
<li class=""><a href="namespaces/default.html#function_mainwpdir">mainwpdir()</a></li>
</ul>
</li>
</ul>
</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="files/includes-functions.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>
Reference in a new issue View git blame Copy permalink