mainwp/mainwp.dev
1
0
Fork 0
mirror of https://gh.wpcy.net/https://github.com/mainwp/mainwp.dev.git synced 2026-07-17 04:14:37 +08:00
Code Issues Projects Packages Activity Actions
mainwp.dev/source-code/dashboard/classes/MainWP-Dashboard-Module-Log-Log-Author.html
Dennis Dornon 5169eec27d Adding Pronamic WordPress Documentor for Hooks
2025-03-17 19:02:54 -04:00

1238 lines
56 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">
<li class="phpdocumentor-breadcrumb"><a href="namespaces/mainwp.html">MainWP</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/mainwp-dashboard.html">Dashboard</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/mainwp-dashboard-module.html">Module</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/mainwp-dashboard-module-log.html">Log</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
Log_Author
<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-Dashboard.html">Dashboard</a></li>
</ul>
</div>
</h2>
<div class="phpdocumentor-label-line">
</div>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="modules/logs/classes/class-log-author.php"><a href="files/modules-logs-classes-class-log-author.html"><abbr title="modules/logs/classes/class-log-author.php">class-log-author.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">20</span>
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#source-view.20" class="phpdocumentor-element-found-in__source" data-line="20" data-modal="source-view" data-src="files/modules/logs/classes/class-log-author.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Class Log_Author.</p>
<h3 id="toc">
Table of Contents
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-properties">
Properties
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a class="" href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#property_id">$id</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Holds User ID.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -public">
<a class="" href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#property_meta">$meta</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Holds User meta data.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a class="" href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#property_user">$user</a>
<span>
&nbsp;: <abbr title="\WP_User">WP_User</abbr> </span>
</dt>
<dd>Holds WP user object connected to &quot;$this&quot; instance.</dd>
</dl>
<h4 id="toc-methods">
Methods
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method___construct">__construct()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Class constructor.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method___get">__get()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Get various user meta data</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method___toString">__toString()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Returns string representation of this object</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method_get_agent">get_agent()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Get the agent of the user</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method_get_agent_label">get_agent_label()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Get the agent label</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method_get_current_agent">get_current_agent()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Look at the environment to detect if an agent is being used</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method_get_display_name">get_display_name()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Get the display name of the user</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method_get_role">get_role()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Tries to find a label for the record&#039;s user_role.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method_is_deleted">is_deleted()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>True if user no longer exists, otherwise false</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method_is_doing_wp_cron">is_doing_wp_cron()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Check if the current request is part of a WP cron task.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method_is_wp_cli">is_wp_cli()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>True if user is WP-CLI, otherwise false</dd>
</dl>
<section class="phpdocumentor-properties">
<h3 class="phpdocumentor-elements__header" id="properties">
Properties
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_id">
$id
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#property_id" 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="modules/logs/classes/class-log-author.php"><a href="files/modules-logs-classes-class-log-author.html"><abbr title="modules/logs/classes/class-log-author.php">class-log-author.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#source-view.27" class="phpdocumentor-element-found-in__source" data-line="27" data-modal="source-view" data-src="files/modules/logs/classes/class-log-author.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Holds User ID.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">$id</span>
</code>
</article>
<article
class="
phpdocumentor-element
-property
-public
"
>
<h4 class="phpdocumentor-element__name" id="property_meta">
$meta
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#property_meta" 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="modules/logs/classes/class-log-author.php"><a href="files/modules-logs-classes-class-log-author.html"><abbr title="modules/logs/classes/class-log-author.php">class-log-author.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">34</span>
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#source-view.34" class="phpdocumentor-element-found-in__source" data-line="34" data-modal="source-view" data-src="files/modules/logs/classes/class-log-author.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Holds User meta data.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">$meta</span>
= <span class="phpdocumentor-signature__default-value">array()</span></code>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_user">
$user
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#property_user" 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="modules/logs/classes/class-log-author.php"><a href="files/modules-logs-classes-class-log-author.html"><abbr title="modules/logs/classes/class-log-author.php">class-log-author.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">41</span>
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#source-view.41" class="phpdocumentor-element-found-in__source" data-line="41" data-modal="source-view" data-src="files/modules/logs/classes/class-log-author.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Holds WP user object connected to &quot;$this&quot; instance.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type"><abbr title="\WP_User">WP_User</abbr></span>
<span class="phpdocumentor-signature__name">$user</span>
</code>
</article>
</section>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.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-Dashboard-Module-Log-Log-Author.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="modules/logs/classes/class-log-author.php"><a href="files/modules-logs-classes-class-log-author.html"><abbr title="modules/logs/classes/class-log-author.php">class-log-author.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">49</span>
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#source-view.49" class="phpdocumentor-element-found-in__source" data-line="49" data-modal="source-view" data-src="files/modules/logs/classes/class-log-author.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Class 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 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>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$user_meta</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">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<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>The user ID.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$user_meta</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">array()</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The user meta array.</p>
</section>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method___get">
__get()
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method___get" 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/classes/class-log-author.php"><a href="files/modules-logs-classes-class-log-author.html"><abbr title="modules/logs/classes/class-log-author.php">class-log-author.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">74</span>
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#source-view.74" class="phpdocumentor-element-found-in__source" data-line="74" data-modal="source-view" data-src="files/modules/logs/classes/class-log-author.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Get various user meta data</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<div class="phpdocumentor-label-line">
</div>
<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">$name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>User meta key.</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method___get#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">devtodo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Make sure this is being covered in the unit tests.</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\MainWP_Exception">MainWP_Exception</abbr></span>
<section class="phpdocumentor-description"><p>Meta not found | User not found.</p>
</section>
</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
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method___toString">
__toString()
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method___toString" 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/classes/class-log-author.php"><a href="files/modules-logs-classes-class-log-author.html"><abbr title="modules/logs/classes/class-log-author.php">class-log-author.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">100</span>
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#source-view.100" class="phpdocumentor-element-found-in__source" data-line="100" data-modal="source-view" data-src="files/modules/logs/classes/class-log-author.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Returns string representation of this object</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__toString</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_get_agent">
get_agent()
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method_get_agent" 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/classes/class-log-author.php"><a href="files/modules-logs-classes-class-log-author.html"><abbr title="modules/logs/classes/class-log-author.php">class-log-author.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">145</span>
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#source-view.145" class="phpdocumentor-element-found-in__source" data-line="145" data-modal="source-view" data-src="files/modules/logs/classes/class-log-author.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Get the agent of the user</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">get_agent</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_get_agent_label">
get_agent_label()
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method_get_agent_label" 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/classes/class-log-author.php"><a href="files/modules-logs-classes-class-log-author.html"><abbr title="modules/logs/classes/class-log-author.php">class-log-author.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">258</span>
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#source-view.258" class="phpdocumentor-element-found-in__source" data-line="258" data-modal="source-view" data-src="files/modules/logs/classes/class-log-author.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Get the agent label</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">get_agent_label</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$agent</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<div class="phpdocumentor-label-line">
</div>
<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">$agent</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Key representing agent.</p>
</section>
</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
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_get_current_agent">
get_current_agent()
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method_get_current_agent" 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/classes/class-log-author.php"><a href="files/modules-logs-classes-class-log-author.html"><abbr title="modules/logs/classes/class-log-author.php">class-log-author.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">230</span>
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#source-view.230" class="phpdocumentor-element-found-in__source" data-line="230" data-modal="source-view" data-src="files/modules/logs/classes/class-log-author.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Look at the environment to detect if an agent is being used</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">get_current_agent</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_get_display_name">
get_display_name()
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method_get_display_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="modules/logs/classes/class-log-author.php"><a href="files/modules-logs-classes-class-log-author.html"><abbr title="modules/logs/classes/class-log-author.php">class-log-author.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">109</span>
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#source-view.109" class="phpdocumentor-element-found-in__source" data-line="109" data-modal="source-view" data-src="files/modules/logs/classes/class-log-author.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Get the display name of the user</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">get_display_name</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_get_role">
get_role()
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method_get_role" 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/classes/class-log-author.php"><a href="files/modules-logs-classes-class-log-author.html"><abbr title="modules/logs/classes/class-log-author.php">class-log-author.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">166</span>
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#source-view.166" class="phpdocumentor-element-found-in__source" data-line="166" data-modal="source-view" data-src="files/modules/logs/classes/class-log-author.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Tries to find a label for the record&#039;s user_role.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">get_role</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>If the user_role exists, use the label associated with it.</p>
<p>Otherwise, if there is a user role label stored as Log meta then use that.
Otherwise, if the user exists, use the label associated with their current role.
Otherwise, use the role slug as the label.</p>
</section>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_is_deleted">
is_deleted()
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method_is_deleted" 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/classes/class-log-author.php"><a href="files/modules-logs-classes-class-log-author.html"><abbr title="modules/logs/classes/class-log-author.php">class-log-author.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">197</span>
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#source-view.197" class="phpdocumentor-element-found-in__source" data-line="197" data-modal="source-view" data-src="files/modules/logs/classes/class-log-author.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">True if user no longer exists, otherwise false</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">is_deleted</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_is_doing_wp_cron">
is_doing_wp_cron()
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method_is_doing_wp_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="modules/logs/classes/class-log-author.php"><a href="files/modules-logs-classes-class-log-author.html"><abbr title="modules/logs/classes/class-log-author.php">class-log-author.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">221</span>
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#source-view.221" class="phpdocumentor-element-found-in__source" data-line="221" data-modal="source-view" data-src="files/modules/logs/classes/class-log-author.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Check if the current request is part of a WP cron task.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">is_doing_wp_cron</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>Note: This will return true for all manual or custom
cron runs even if the default front-end cron is disabled.</p>
<p>We're not using <code class="prettyprint">wp_doing_cron()</code> since it was introduced
only in WordPress 4.8.0.</p>
</section>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_is_wp_cli">
is_wp_cli()
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method_is_wp_cli" 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/classes/class-log-author.php"><a href="files/modules-logs-classes-class-log-author.html"><abbr title="modules/logs/classes/class-log-author.php">class-log-author.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">206</span>
<a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#source-view.206" class="phpdocumentor-element-found-in__source" data-line="206" data-modal="source-view" data-src="files/modules/logs/classes/class-log-author.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">True if user is WP-CLI, otherwise false</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">is_wp_cli</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</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/modules/logs/classes/class-log-author.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="classes/MainWP-Dashboard-Module-Log-Log-Author.html#toc-properties">Properties</a></li>
<li><a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#toc-methods">Methods</a></li>
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Properties</li>
<li>
<ul class="phpdocumentor-list -clean">
<li class=""><a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#property_id">$id</a></li>
<li class=""><a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#property_meta">$meta</a></li>
<li class=""><a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#property_user">$user</a></li>
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Methods</li>
<li>
<ul class="phpdocumentor-list -clean">
<li class=""><a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method___construct">__construct()</a></li>
<li class=""><a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method___get">__get()</a></li>
<li class=""><a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method___toString">__toString()</a></li>
<li class=""><a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method_get_agent">get_agent()</a></li>
<li class=""><a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method_get_agent_label">get_agent_label()</a></li>
<li class=""><a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method_get_current_agent">get_current_agent()</a></li>
<li class=""><a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method_get_display_name">get_display_name()</a></li>
<li class=""><a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method_get_role">get_role()</a></li>
<li class=""><a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method_is_deleted">is_deleted()</a></li>
<li class=""><a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method_is_doing_wp_cron">is_doing_wp_cron()</a></li>
<li class=""><a href="classes/MainWP-Dashboard-Module-Log-Log-Author.html#method_is_wp_cli">is_wp_cli()</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="classes/MainWP-Dashboard-Module-Log-Log-Author.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