Ticket #26203: 26203.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 this table is being generated for.
+         *
+         * @since 3.1.0
+         * @var   int $site_id The site ID.
+         */
         var $site_id;
+
+        /**
+         * True if the table is being generated for the multisite site users page.
+         *
+         * @since 3.1.0
+         * @var   bool $is_site_users
+         */
         var $is_site_users;
 
+        /**
+         * Constructor
+         *
+         * @since 3.1.0
+         * @see   WP_List_Table::__construct()
+         */
         function __construct( $args = array() ) {
                 parent::__construct( array(
                         'singular' => 'user',
@@ -25 +44 @@
                         $this->site_id = isset( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : 0;
         }
 
+        /**
+         * @since 3.1.0
+         * @see   WP_List_Table::__construct()
+         */
         function ajax_user_can() {
                 if ( $this->is_site_users )
                         return current_user_can( 'manage_sites' );
@@ -32 +55 @@
                         return current_user_can( 'list_users' );
         }
 
+        /**
+         * @since 3.1.0
+         * @see   WP_List_Table::prepare_items()
+         */
         function prepare_items() {
                 global $role, $usersearch;
 
@@ -75 +102 @@
                 ) );
         }
 
+        /**
+         * @since 3.1.0
+         * @see   WP_List_Table::no_items()
+         */
         function no_items() {
                 _e( 'No matching users were found.' );
         }
 
+        /**
+         * Returns an associative array listing all the views that can be used with this table.
+         *
+         * Provides a list of roles, andd user count for that role for easy filter of the user table.
+         *
+         * @since  3.1.0
+         * @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 +159 @@
                 return $role_links;
         }
 
+        /**
+         * @since  3.1.0
+         * @see    WP_List_Table::get_bulk_actions()
+         */
         function get_bulk_actions() {
                 $actions = array();
 
@@ -133 +177 @@
                 return $actions;
         }
 
+        /**
+         * Output the controls to allow user roles to be changed in bulk.
+         *
+         * @since 3.1.0
+         * @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;
@@ -148 +199 @@
                         submit_button( __( 'Change' ), 'button', 'changeit', false );
                 endif;
 
+                /**
+                 * Triggered after the extra tablenav on the user list page
+                 *
+                 * @since 3.5.0
+                 */
                 do_action( 'restrict_manage_users' );
                 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
+         * @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 +224 @@
                 return parent::current_action();
         }
 
+        /**
+         *  @since  3.1.0
+         *  @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 +245 @@
                 return $c;
         }
 
+        /**
+         * @since 3.1.0
+         * @see   WP_List_Table::get_sortable_columns()
+         */
         function get_sortable_columns() {
                 $c = array(
                         'username' => 'login',
@@ -188 +262 @@
                 return $c;
         }
 
+        /**
+         * @since 3.1.0
+         * @see   WP_List_Table::display_rows()
+         */
         function display_rows() {
                 // Query the post counts for this page
                 if ( ! $this->is_site_users )
@@ -216 +294 @@
         /**
          * Generate HTML for a single row on the users.php admin panel.
          *
-         * @since 2.1.0
+         * @since 3.1.0
          *
          * @param object $user_object
          * @param string $style Optional. Attributes added to the TR element. Must be sanitized.
@@ -257 +335 @@
                                 $actions['delete'] = "<a class='submitdelete' href='" . wp_nonce_url( "users.php?action=delete&amp;user=$user_object->ID", 'bulk-users' ) . "'>" . __( 'Delete' ) . "</a>";
                         if ( is_multisite() && get_current_user_id() != $user_object->ID && current_user_can( 'remove_user', $user_object->ID ) )
                                 $actions['remove'] = "<a class='submitdelete' href='" . wp_nonce_url( $url."action=remove&amp;user=$user_object->ID", 'bulk-users' ) . "'>" . __( 'Remove' ) . "</a>";
+                        /**
+                         * The actions available against a user.
+                         *
+                         * @since 3.1.0
+                         * @var   array $actions Array of actions available
+                         * @var   WP_User $user_object The user object being listed.
+                         */
                         $actions = apply_filters( 'user_row_actions', $actions, $user_object );
                         $edit .= $this->row_actions( $actions );
 
@@ -313 +398 @@
                                         break;
                                 default:
                                         $r .= "<td $attributes>";
+                                        /**
+                                         * Provide output for a custom column on the users list table.
+                                         *
+                                         * @since 3.1.0
+                                         * @var   string The current content for the column.
+                                         * @var   string The column being rendered.
+                                         * @var   int    The user ID being rendered.
+                                         */
                                         $r .= apply_filters( 'manage_users_custom_column', '', $column_name, $user_object->ID );
                                         $r .= "</td>";
                         }