Ticket #26564: 26564.2.diff

src/wp-admin/includes/class-wp-users-list-table.php

@@ -9 +9 @@
  */
 class WP_Users_List_Table extends WP_List_Table {
 
+        /**
+         * The site ID that WP_Users_List_Table is being generated for.
+         *
+         * @since 3.1.0
+         * @access public
+         * @var int $site_id The site ID.
+         */
         var $site_id;
+
+        /**
+         * Whether the WP_Users_List_Table instance is being generated for
+         * the Multisite users page or not. True for Multisite.
+         *
+         * @since 3.1.0
+         * @access public
+         *
+         * @var bool $is_site_users
+         */
         var $is_site_users;
 
+        /**
+         * Constructor.
+         *
+         * @since 3.1.0
+         * @access public
+         *
+         * @see WP_List_Table::__construct()
+         */
         function __construct( $args = array() ) {
                 parent::__construct( array(
                         'singular' => 'user',
@@ -25 +50 @@
                         $this->site_id = isset( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : 0;
         }
 
+        /**
+         * Check the current user's permissions.
+         *
+         * @since 3.1.0
+         * @access public
+         *
+         * @see WP_List_Table::__construct()
+         */
         function ajax_user_can() {
                 if ( $this->is_site_users )
                         return current_user_can( 'manage_sites' );
@@ -32 +65 @@
                         return current_user_can( 'list_users' );
         }
 
+        /**
+         * Prepare the list of users for display.
+         *
+         * @since 3.1.0
+         * @access public
+         *
+         * @see WP_List_Table::prepare_items()
+         */
         function prepare_items() {
                 global $role, $usersearch;
 
@@ -75 +116 @@
                 ) );
         }
 
+        /**
+         * Output 'no users' message.
+         *
+         * @since 3.1.0
+         * @access public
+         *
+         * @see WP_List_Table::no_items()
+         */
         function no_items() {
                 _e( 'No matching users were found.' );
         }
 
+        /**
+         * 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
+         * filter of the user table.
+         *
+         * @since  3.1.0
+         * @access public
+         *
+         * @see WP_List_Table::get_views()
+         *
+         * @return array An array of HTML links, one for each view.
+         */
         function get_views() {
                 global $wp_roles, $role;
 
@@ -119 +182 @@
                 return $role_links;
         }
 
+        /**
+         * Get an associative array of bulk actions available on this table.
+         *
+         * @since  3.1.0
+         * @access public
+         *
+         * @see WP_List_Table::get_bulk_actions()
+         *
+         * @return array Array of bulk actions.
+         */
         function get_bulk_actions() {
                 $actions = array();
 
@@ -133 +206 @@
                 return $actions;
         }
 
+        /**
+         * Output the controls to allow user roles to be changed in bulk.
+         *
+         * @since 3.1.0
+         * @access public
+         *
+         * @see WP_List_Table::extra_tablenav()
+         *
+         * @param string $which Whether this is being invoked above ("top")
+         *                      or below the table ("bottom").
+         */
         function extra_tablenav( $which ) {
                 if ( 'top' != $which )
                         return;
@@ -152 +236 @@
                 echo '</div>';
         }
 
+        /**
+         * Capture the bulk action required, and return it.
+         *
+         * Overriden from the base class implementation to capture
+         * the role change drop-down.
+         *
+         * @since  3.1.0
+         * @access public
+         *
+         * @see WP_List_Table::current_action()
+         *
+         * @return string The bulk action required.
+         */
         function current_action() {
                 if ( isset($_REQUEST['changeit']) && !empty($_REQUEST['new_role']) )
                         return 'promote';
@@ -159 +256 @@
                 return parent::current_action();
         }
 
+        /**
+         * Get a list of columns for the list table.
+         *
+         * @since  3.1.0
+         * @access public
+         *
+         * @see WP_List_Table::get_columns()
+         *
+         * @return array Array in which the key is the ID of the column,
+         *               and the value is the description.
+         */
         function get_columns() {
                 $c = array(
                         'cb'       => '<input type="checkbox" />',
@@ -175 +283 @@
                 return $c;
         }
 
+        /**
+         * Get a list of sortable columns for the list table.
+         *
+         * @since 3.1.0
+         * @access public
+         *
+         * @see WP_List_Table::get_sortable_columns()
+         *
+         * @return array Array of sortable columns.
+         */
         function get_sortable_columns() {
                 $c = array(
                         'username' => 'login',
@@ -188 +306 @@
                 return $c;
         }
 
+        /**
+         * Generate the list table rows.
+         *
+         * @since 3.1.0
+         * @access public
+         *
+         * @see WP_List_Table::display_rows()
+         */
         function display_rows() {
                 // Query the post counts for this page
                 if ( ! $this->is_site_users )
@@ -216 +342 @@
         /**
          * Generate HTML for a single row on the users.php admin panel.
          *
-         * @since 2.1.0
+         * @since 3.1.0
+         * @access public
          *
-         * @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
+         * @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.
          */
         function single_row( $user_object, $style = '', $role = '', $numposts = 0 ) {
                 global $wp_roles;