mainwp/mainwp.dev
1
0
Fork 0
mirror of https://gh.llkk.cc/https://github.com/mainwp/mainwp.dev.git synced 2025-10-04 15:43:04 +08:00
Code Issues Projects Packages Wiki Activity Actions
mainwp.dev/code-docs/classes/MainWP-Child-MainWP-Child-Users.html
Dennis Dornon 5bfaae187c Local Working Update 
Commiting semi-working version
2025-03-14 12:25:11 -04:00

861 lines
43 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>MainWP Dashboard Code Reference</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/js/all.min.js" integrity="sha256-0vuk8LXoyrmCjp1f0O300qo1M75ZQyhH9X3J6d+scmk=" crossorigin="anonymous"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">MainWP Dashboard Code Reference</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -four phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h3 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/default.html"><abbr title="\">Global</abbr></a></h3>
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/mainwp.html"><abbr title="\MainWP">MainWP</abbr></a></h4>
<ul class="phpdocumentor-list">
<li><a href="namespaces/mainwp-child.html"><abbr title="\MainWP\Child">Child</abbr></a></li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/composer.html"><abbr title="\Composer">Composer</abbr></a></h4>
<ul class="phpdocumentor-list">
<li><a href="namespaces/composer-autoload.html"><abbr title="\Composer\Autoload">Autoload</abbr></a></li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/paragonie.html"><abbr title="\ParagonIE">ParagonIE</abbr></a></h4>
<ul class="phpdocumentor-list">
<li><a href="namespaces/paragonie-constanttime.html"><abbr title="\ParagonIE\ConstantTime">ConstantTime</abbr></a></li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/phpseclib3.html"><abbr title="\phpseclib3">phpseclib3</abbr></a></h4>
<ul class="phpdocumentor-list">
<li><a href="namespaces/phpseclib3-common.html"><abbr title="\phpseclib3\Common">Common</abbr></a></li>
<li><a href="namespaces/phpseclib3-crypt.html"><abbr title="\phpseclib3\Crypt">Crypt</abbr></a></li>
<li><a href="namespaces/phpseclib3-exception.html"><abbr title="\phpseclib3\Exception">Exception</abbr></a></li>
<li><a href="namespaces/phpseclib3-file.html"><abbr title="\phpseclib3\File">File</abbr></a></li>
<li><a href="namespaces/phpseclib3-math.html"><abbr title="\phpseclib3\Math">Math</abbr></a></li>
<li><a href="namespaces/phpseclib3-net.html"><abbr title="\phpseclib3\Net">Net</abbr></a></li>
<li><a href="namespaces/phpseclib3-system.html"><abbr title="\phpseclib3\System">System</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/MainWP.html"><abbr title="\MainWP">MainWP</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/MainWP-Child.html"><abbr title="\MainWP\Child">Child</abbr></a></li>
<li><a href="packages/MainWP-ChildCreditsPlugin.html"><abbr title="\MainWP\ChildCreditsPlugin">ChildCreditsPlugin</abbr></a></li>
<li><a href="packages/MainWP-Dashboard.html"><abbr title="\MainWP\Dashboard">Dashboard</abbr></a></li>
</ul>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/MainWPChild.html"><abbr title="\MainWPChild">MainWPChild</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/ParagonIE.html"><abbr title="\ParagonIE">ParagonIE</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/ParagonIE-ConstantTime.html"><abbr title="\ParagonIE\ConstantTime">ConstantTime</abbr></a></li>
</ul>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Mainwp.html"><abbr title="\Mainwp">Mainwp</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/Mainwp-Child.html"><abbr title="\Mainwp\Child">Child</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="namespaces/mainwp.html">MainWP</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/mainwp-child.html">Child</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
MainWP_Child_Users
<div class="phpdocumentor-element__package">
in package
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="packages/MainWP.html">MainWP</a></li>
<li class="phpdocumentor-breadcrumb"><a href="packages/MainWP-Child.html">Child</a></li>
</ul>
</div>
</h2>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/class-mainwp-child-users.php"><a href="files/class-class-mainwp-child-users.html"><abbr title="class/class-mainwp-child-users.php">class-mainwp-child-users.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">17</span>
</aside>
<p class="phpdocumentor-summary">Class MainWP_Child_Users</p>
<section class="phpdocumentor-description"><p>Manage users on the site.</p>
</section>
<h3 id="toc">
Table of Contents
<a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/MainWP-Child-MainWP-Child-Users.html#property_instance">$instance</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Public static variable to hold the single instance of the class.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MainWP-Child-MainWP-Child-Users.html#method___construct">__construct()</a>
<span>
&nbsp;: mixed
</span>
</dt>
<dd>MainWP_Child_Users constructor.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MainWP-Child-MainWP-Child-Users.html#method_edit_user">edit_user()</a>
<span>
&nbsp;: string|int
</span>
</dt>
<dd>Edit existing user.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MainWP-Child-MainWP-Child-Users.html#method_get_all_users">get_all_users()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;
</span>
</dt>
<dd>Get all child site users.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MainWP-Child-MainWP-Child-Users.html#method_get_all_users_int">get_all_users_int()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;
</span>
</dt>
<dd>Get all users.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MainWP-Child-MainWP-Child-Users.html#method_get_class_name">get_class_name()</a>
<span>
&nbsp;: string
</span>
</dt>
<dd>Method get_class_name()</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MainWP-Child-MainWP-Child-Users.html#method_get_instance">get_instance()</a>
<span>
&nbsp;: mixed
</span>
</dt>
<dd>Method get_instance()</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MainWP-Child-MainWP-Child-Users.html#method_get_user_to_edit">get_user_to_edit()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt;
</span>
</dt>
<dd>Get Child Site user to edit.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MainWP-Child-MainWP-Child-Users.html#method_new_admin_password">new_admin_password()</a>
<span>
&nbsp;: mixed
</span>
</dt>
<dd>Set a new administrator password.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MainWP-Child-MainWP-Child-Users.html#method_new_user">new_user()</a>
<span>
&nbsp;: mixed
</span>
</dt>
<dd>Create a new user.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MainWP-Child-MainWP-Child-Users.html#method_search_users">search_users()</a>
<span>
&nbsp;: mixed
</span>
</dt>
<dd>Search child site users.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MainWP-Child-MainWP-Child-Users.html#method_user_action">user_action()</a>
<span>
&nbsp;: mixed
</span>
</dt>
<dd>User actions: changeRole, update_password, edit, update_user.</dd>
</dl>
<section class="phpdocumentor-properties">
<h3 class="phpdocumentor-elements__header" id="properties">
Properties
<a href="classes/MainWP-Child-MainWP-Child-Users.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="
phpdocumentor-element
-property
-protected
-static "
>
<h4 class="phpdocumentor-element__name" id="property_instance">
$instance
<a href="classes/MainWP-Child-MainWP-Child-Users.html#property_instance" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/class-mainwp-child-users.php"><a href="files/class-class-mainwp-child-users.html"><abbr title="class/class-mainwp-child-users.php">class-mainwp-child-users.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">24</span>
</aside>
<p class="phpdocumentor-summary">Public static variable to hold the single instance of the class.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">$instance</span>
= <span class="phpdocumentor-signature__default-value">null</span></code>
<section class="phpdocumentor-description"></section>
</article>
</section>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/MainWP-Child-MainWP-Child-Users.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method___construct">
__construct()
<a href="classes/MainWP-Child-MainWP-Child-Users.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/class-mainwp-child-users.php"><a href="files/class-class-mainwp-child-users.html"><abbr title="class/class-mainwp-child-users.php">class-mainwp-child-users.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">42</span>
</aside>
<p class="phpdocumentor-summary">MainWP_Child_Users constructor.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Run any time class is called.</p>
</section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_edit_user">
edit_user()
<a href="classes/MainWP-Child-MainWP-Child-Users.html#method_edit_user" 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-child-users.php"><a href="files/class-class-mainwp-child-users.html"><abbr title="class/class-mainwp-child-users.php">class-mainwp-child-users.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">311</span>
</aside>
<p class="phpdocumentor-summary">Edit existing user.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">edit_user</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$user_id</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$data</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|int</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$user_id</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>User ID.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$data</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>Data to edit.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string|int</span>
&mdash;
<section class="phpdocumentor-description"><p>Return error string on failure or user ID on success.</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_get_all_users">
get_all_users()
<a href="classes/MainWP-Child-MainWP-Child-Users.html#method_get_all_users" 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-child-users.php"><a href="files/class-class-mainwp-child-users.html"><abbr title="class/class-mainwp-child-users.php">class-mainwp-child-users.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">207</span>
</aside>
<p class="phpdocumentor-summary">Get all child site users.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">get_all_users</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">$return_results</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$return_results</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">false</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Whether or not to return. Default: false.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">uses</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-MainWP-Helper.html#method_write"><abbr title="\MainWP\Child\MainWP_Helper::write()">MainWP_Helper::write()</abbr></a></span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
&mdash;
<section class="phpdocumentor-description"><p>Return array of $allusers.</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_get_all_users_int">
get_all_users_int()
<a href="classes/MainWP-Child-MainWP-Child-Users.html#method_get_all_users_int" 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-child-users.php"><a href="files/class-class-mainwp-child-users.html"><abbr title="class/class-mainwp-child-users.php">class-mainwp-child-users.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">Get all users.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">get_all_users_int</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">$number</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$number</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">false</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Number parameter.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
&mdash;
<section class="phpdocumentor-description"><p>Return array of $allusers.</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_get_class_name">
get_class_name()
<a href="classes/MainWP-Child-MainWP-Child-Users.html#method_get_class_name" 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-child-users.php"><a href="files/class-class-mainwp-child-users.html"><abbr title="class/class-mainwp-child-users.php">class-mainwp-child-users.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">33</span>
</aside>
<p class="phpdocumentor-summary">Method get_class_name()</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">get_class_name</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"><p>Get class name.</p>
</section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"><p><strong>CLASS</strong> Class name.</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_get_instance">
get_instance()
<a href="classes/MainWP-Child-MainWP-Child-Users.html#method_get_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="class/class-mainwp-child-users.php"><a href="files/class-class-mainwp-child-users.html"><abbr title="class/class-mainwp-child-users.php">class-mainwp-child-users.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">52</span>
</aside>
<p class="phpdocumentor-summary">Method get_instance()</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">get_instance</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Create a public static instance.</p>
</section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"><p>Class instance.</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_get_user_to_edit">
get_user_to_edit()
<a href="classes/MainWP-Child-MainWP-Child-Users.html#method_get_user_to_edit" 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-child-users.php"><a href="files/class-class-mainwp-child-users.html"><abbr title="class/class-mainwp-child-users.php">class-mainwp-child-users.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">455</span>
</aside>
<p class="phpdocumentor-summary">Get Child Site user to edit.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">get_user_to_edit</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$user_id</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$user_id</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>User ID.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
&mdash;
<section class="phpdocumentor-description"><p>Return array of $edit_data.</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_new_admin_password">
new_admin_password()
<a href="classes/MainWP-Child-MainWP-Child-Users.html#method_new_admin_password" 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-child-users.php"><a href="files/class-class-mainwp-child-users.html"><abbr title="class/class-mainwp-child-users.php">class-mainwp-child-users.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">510</span>
</aside>
<p class="phpdocumentor-summary">Set a new administrator password.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">new_admin_password</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">uses</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-MainWP-Helper.html#method_write"><abbr title="\MainWP\Child\MainWP_Helper::write()">MainWP_Helper::write()</abbr></a></span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">uses</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>\MainWP\Child\MainWP_Helper::instance()-&gt;error()</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_new_user">
new_user()
<a href="classes/MainWP-Child-MainWP-Child-Users.html#method_new_user" 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-child-users.php"><a href="files/class-class-mainwp-child-users.html"><abbr title="class/class-mainwp-child-users.php">class-mainwp-child-users.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">570</span>
</aside>
<p class="phpdocumentor-summary">Create a new user.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">new_user</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">uses</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-MainWP-Helper.html#method_write"><abbr title="\MainWP\Child\MainWP_Helper::write()">MainWP_Helper::write()</abbr></a></span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">uses</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>\MainWP\Child\MainWP_Helper::instance()-&gt;error()</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_search_users">
search_users()
<a href="classes/MainWP-Child-MainWP-Child-Users.html#method_search_users" 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-child-users.php"><a href="files/class-class-mainwp-child-users.html"><abbr title="class/class-mainwp-child-users.php">class-mainwp-child-users.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">242</span>
</aside>
<p class="phpdocumentor-summary">Search child site users.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">search_users</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">uses</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-MainWP-Helper.html#method_write"><abbr title="\MainWP\Child\MainWP_Helper::write()">MainWP_Helper::write()</abbr></a></span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_user_action">
user_action()
<a href="classes/MainWP-Child-MainWP-Child-Users.html#method_user_action" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/class-mainwp-child-users.php"><a href="files/class-class-mainwp-child-users.html"><abbr title="class/class-mainwp-child-users.php">class-mainwp-child-users.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">65</span>
</aside>
<p class="phpdocumentor-summary">User actions: changeRole, update_password, edit, update_user.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">user_action</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">uses</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/MainWP-Child-MainWP-Helper.html#method_write"><abbr title="\MainWP\Child\MainWP_Helper::write()">MainWP_Helper::write()</abbr></a></span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
</section>
</article>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
</div>
<a href="classes/MainWP-Child-MainWP-Child-Users.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
</body>
</html>
Reference in a new issue View git blame Copy permalink