<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[27301] trunk/src/wp-admin/includes/class-wp-users-list-table.php: Improve inline documentation for `WP_Users_List_Table`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/27301">27301</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2014-02-26 22:19:10 +0000 (Wed, 26 Feb 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Improve inline documentation for `WP_Users_List_Table`.
Props leewillis77 for the initial patch.
Fixes <a href="http://core.trac.wordpress.org/ticket/26564">#26564</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasswpuserslisttablephp">trunk/src/wp-admin/includes/class-wp-users-list-table.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclasswpuserslisttablephp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-admin/includes/class-wp-users-list-table.php (27300 => 27301)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-admin/includes/class-wp-users-list-table.php 2014-02-26 22:04:52 UTC (rev 27300)
+++ trunk/src/wp-admin/includes/class-wp-users-list-table.php 2014-02-26 22:19:10 UTC (rev 27301)
</span><span class="lines">@@ -2,16 +2,38 @@
</span><span class="cx"> /**
</span><span class="cx"> * Users List Table class.
</span><span class="cx"> *
</span><ins>+ * @since 3.1.0
+ * @access private
+ *
</ins><span class="cx"> * @package WordPress
</span><span class="cx"> * @subpackage List_Table
</span><del>- * @since 3.1.0
- * @access private
</del><span class="cx"> */
</span><span class="cx"> class WP_Users_List_Table extends WP_List_Table {
</span><span class="cx">
</span><ins>+ /**
+ * Site ID to generate the Users list table for.
+ *
+ * @since 3.1.0
+ * @access public
+ * @var int
+ */
</ins><span class="cx"> var $site_id;
</span><ins>+
+ /**
+ * Whether or not the current Users list table is for Multisite.
+ *
+ * @since 3.1.0
+ * @access public
+ * @var bool
+ */
</ins><span class="cx"> var $is_site_users;
</span><span class="cx">
</span><ins>+ /**
+ * Constructor.
+ *
+ * @since 3.1.0
+ * @access public
+ */
</ins><span class="cx"> function __construct( $args = array() ) {
</span><span class="cx"> parent::__construct( array(
</span><span class="cx"> 'singular' => 'user',
</span><span class="lines">@@ -25,6 +47,12 @@
</span><span class="cx"> $this->site_id = isset( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : 0;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Check the current user's permissions.
+ *
+ * @since 3.1.0
+ * @access public
+ */
</ins><span class="cx"> function ajax_user_can() {
</span><span class="cx"> if ( $this->is_site_users )
</span><span class="cx"> return current_user_can( 'manage_sites' );
</span><span class="lines">@@ -32,6 +60,12 @@
</span><span class="cx"> return current_user_can( 'list_users' );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Prepare the users list for display.
+ *
+ * @since 3.1.0
+ * @access public
+ */
</ins><span class="cx"> function prepare_items() {
</span><span class="cx"> global $role, $usersearch;
</span><span class="cx">
</span><span class="lines">@@ -75,10 +109,28 @@
</span><span class="cx"> ) );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Output 'no users' message.
+ *
+ * @since 3.1.0
+ * @access public
+ */
</ins><span class="cx"> function no_items() {
</span><span class="cx"> _e( 'No matching users were found.' );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Return an associative array listing all the views that can be used
+ * with this table.
+ *
+ * Provides a list of roles and user count for that role for easy
+ * filtering of the user table.
+ *
+ * @since 3.1.0
+ * @access public
+ *
+ * @return array An array of HTML links, one for each view.
+ */
</ins><span class="cx"> function get_views() {
</span><span class="cx"> global $wp_roles, $role;
</span><span class="cx">
</span><span class="lines">@@ -119,6 +171,14 @@
</span><span class="cx"> return $role_links;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Retrieve an associative array of bulk actions available on this table.
+ *
+ * @since 3.1.0
+ * @access public
+ *
+ * @return array Array of bulk actions.
+ */
</ins><span class="cx"> function get_bulk_actions() {
</span><span class="cx"> $actions = array();
</span><span class="cx">
</span><span class="lines">@@ -133,6 +193,15 @@
</span><span class="cx"> return $actions;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Output the controls to allow user roles to be changed in bulk.
+ *
+ * @since 3.1.0
+ * @access public
+ *
+ * @param string $which Whether this is being invoked above ("top")
+ * or below the table ("bottom").
+ */
</ins><span class="cx"> function extra_tablenav( $which ) {
</span><span class="cx"> if ( 'top' != $which )
</span><span class="cx"> return;
</span><span class="lines">@@ -152,6 +221,17 @@
</span><span class="cx"> echo '</div>';
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Capture the bulk action required, and return it.
+ *
+ * Overridden from the base class implementation to capture
+ * the role change drop-down.
+ *
+ * @since 3.1.0
+ * @access public
+ *
+ * @return string The bulk action required.
+ */
</ins><span class="cx"> function current_action() {
</span><span class="cx"> if ( isset($_REQUEST['changeit']) && !empty($_REQUEST['new_role']) )
</span><span class="cx"> return 'promote';
</span><span class="lines">@@ -159,6 +239,15 @@
</span><span class="cx"> return parent::current_action();
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Get a list of columns for the list table.
+ *
+ * @since 3.1.0
+ * @access public
+ *
+ * @return array Array in which the key is the ID of the column,
+ * and the value is the description.
+ */
</ins><span class="cx"> function get_columns() {
</span><span class="cx"> $c = array(
</span><span class="cx"> 'cb' => '<input type="checkbox" />',
</span><span class="lines">@@ -175,6 +264,14 @@
</span><span class="cx"> return $c;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Get a list of sortable columns for the list table.
+ *
+ * @since 3.1.0
+ * @access public
+ *
+ * @return array Array of sortable columns.
+ */
</ins><span class="cx"> function get_sortable_columns() {
</span><span class="cx"> $c = array(
</span><span class="cx"> 'username' => 'login',
</span><span class="lines">@@ -188,6 +285,12 @@
</span><span class="cx"> return $c;
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Generate the list table rows.
+ *
+ * @since 3.1.0
+ * @access public
+ */
</ins><span class="cx"> function display_rows() {
</span><span class="cx"> // Query the post counts for this page
</span><span class="cx"> if ( ! $this->is_site_users )
</span><span class="lines">@@ -216,13 +319,16 @@
</span><span class="cx"> /**
</span><span class="cx"> * Generate HTML for a single row on the users.php admin panel.
</span><span class="cx"> *
</span><del>- * @since 2.1.0
</del><ins>+ * @since 3.1.0
+ * @access public
</ins><span class="cx"> *
</span><del>- * @param object $user_object
- * @param string $style Optional. Attributes added to the TR element. Must be sanitized.
- * @param string $role Key for the $wp_roles array.
- * @param int $numposts Optional. Post count to display for this user. Defaults to zero, as in, a new user has made zero posts.
- * @return string
</del><ins>+ * @param object $user_object The current user object.
+ * @param string $style Optional. Style attributes added to the <tr> element.
+ * Must be sanitized. Default empty.
+ * @param string $role Optional. Key for the $wp_roles array. Default empty.
+ * @param int $numposts Optional. Post count to display for this user. Defaults
+ * to zero, as in, a new user has made zero posts.
+ * @return string Output for a single row.
</ins><span class="cx"> */
</span><span class="cx"> function single_row( $user_object, $style = '', $role = '', $numposts = 0 ) {
</span><span class="cx"> global $wp_roles;
</span></span></pre>
</div>
</div>
</body>
</html>