]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-admin/includes/class-wp-users-list-table.php
WordPress 4.2
[autoinstalls/wordpress.git] / wp-admin / includes / class-wp-users-list-table.php
index adb8321475528961f8de6e483acd0322453217dc..500673637068075cd277f3d075ef4209dd34b0f0 100644 (file)
@@ -2,40 +2,78 @@
 /**
  * Users List Table class.
  *
 /**
  * Users List Table class.
  *
- * @package WordPress
- * @subpackage List_Table
  * @since 3.1.0
  * @access private
  * @since 3.1.0
  * @access private
+ *
+ * @package WordPress
+ * @subpackage List_Table
  */
 class WP_Users_List_Table extends WP_List_Table {
 
  */
 class WP_Users_List_Table extends WP_List_Table {
 
-       var $site_id;
-       var $is_site_users;
-
-       function __construct() {
-               $screen = get_current_screen();
-               $this->is_site_users = 'site-users-network' == $screen->id;
+       /**
+        * Site ID to generate the Users list table for.
+        *
+        * @since 3.1.0
+        * @access public
+        * @var int
+        */
+       public $site_id;
 
 
-               if ( $this->is_site_users )
-                       $this->site_id = isset( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : 0;
+       /**
+        * Whether or not the current Users list table is for Multisite.
+        *
+        * @since 3.1.0
+        * @access public
+        * @var bool
+        */
+       public $is_site_users;
 
 
+       /**
+        * Constructor.
+        *
+        * @since 3.1.0
+        * @access public
+        *
+        * @see WP_List_Table::__construct() for more information on default arguments.
+        *
+        * @param array $args An associative array of arguments.
+        */
+       public function __construct( $args = array() ) {
                parent::__construct( array(
                        'singular' => 'user',
                parent::__construct( array(
                        'singular' => 'user',
-                       'plural'   => 'users'
+                       'plural'   => 'users',
+                       'screen'   => isset( $args['screen'] ) ? $args['screen'] : null,
                ) );
                ) );
+
+               $this->is_site_users = 'site-users-network' == $this->screen->id;
+
+               if ( $this->is_site_users )
+                       $this->site_id = isset( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : 0;
        }
 
        }
 
-       function ajax_user_can() {
+       /**
+        * Check the current user's permissions.
+        *
+        * @since 3.1.0
+        * @access public
+        */
+       public function ajax_user_can() {
                if ( $this->is_site_users )
                        return current_user_can( 'manage_sites' );
                else
                        return current_user_can( 'list_users' );
        }
 
                if ( $this->is_site_users )
                        return current_user_can( 'manage_sites' );
                else
                        return current_user_can( 'list_users' );
        }
 
-       function prepare_items() {
+       /**
+        * Prepare the users list for display.
+        *
+        * @since 3.1.0
+        * @access public
+        */
+       public function prepare_items() {
                global $role, $usersearch;
 
                global $role, $usersearch;
 
-               $usersearch = isset( $_REQUEST['s'] ) ? $_REQUEST['s'] : '';
+               $usersearch = isset( $_REQUEST['s'] ) ? wp_unslash( trim( $_REQUEST['s'] ) ) : '';
 
                $role = isset( $_REQUEST['role'] ) ? $_REQUEST['role'] : '';
 
 
                $role = isset( $_REQUEST['role'] ) ? $_REQUEST['role'] : '';
 
@@ -75,11 +113,29 @@ class WP_Users_List_Table extends WP_List_Table {
                ) );
        }
 
                ) );
        }
 
-       function no_items() {
-               _e( 'No matching users were found.' );
+       /**
+        * Output 'no users' message.
+        *
+        * @since 3.1.0
+        * @access public
+        */
+       public function no_items() {
+               _e( 'No users found.' );
        }
 
        }
 
-       function get_views() {
+       /**
+        * 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 protected
+        *
+        * @return array An array of HTML links, one for each view.
+        */
+       protected function get_views() {
                global $wp_roles, $role;
 
                if ( $this->is_site_users ) {
                global $wp_roles, $role;
 
                if ( $this->is_site_users ) {
@@ -95,7 +151,6 @@ class WP_Users_List_Table extends WP_List_Table {
                $avail_roles =& $users_of_blog['avail_roles'];
                unset($users_of_blog);
 
                $avail_roles =& $users_of_blog['avail_roles'];
                unset($users_of_blog);
 
-               $current_role = false;
                $class = empty($role) ? ' class="current"' : '';
                $role_links = array();
                $role_links['all'] = "<a href='$url'$class>" . sprintf( _nx( 'All <span class="count">(%s)</span>', 'All <span class="count">(%s)</span>', $total_users, 'users' ), number_format_i18n( $total_users ) ) . '</a>';
                $class = empty($role) ? ' class="current"' : '';
                $role_links = array();
                $role_links['all'] = "<a href='$url'$class>" . sprintf( _nx( 'All <span class="count">(%s)</span>', 'All <span class="count">(%s)</span>', $total_users, 'users' ), number_format_i18n( $total_users ) ) . '</a>';
@@ -106,7 +161,6 @@ class WP_Users_List_Table extends WP_List_Table {
                        $class = '';
 
                        if ( $this_role == $role ) {
                        $class = '';
 
                        if ( $this_role == $role ) {
-                               $current_role = $role;
                                $class = ' class="current"';
                        }
 
                                $class = ' class="current"';
                        }
 
@@ -119,7 +173,15 @@ class WP_Users_List_Table extends WP_List_Table {
                return $role_links;
        }
 
                return $role_links;
        }
 
-       function get_bulk_actions() {
+       /**
+        * Retrieve an associative array of bulk actions available on this table.
+        *
+        * @since  3.1.0
+        * @access protected
+        *
+        * @return array Array of bulk actions.
+        */
+       protected function get_bulk_actions() {
                $actions = array();
 
                if ( is_multisite() ) {
                $actions = array();
 
                if ( is_multisite() ) {
@@ -133,31 +195,68 @@ class WP_Users_List_Table extends WP_List_Table {
                return $actions;
        }
 
                return $actions;
        }
 
-       function extra_tablenav( $which ) {
+       /**
+        * Output the controls to allow user roles to be changed in bulk.
+        *
+        * @since 3.1.0
+        * @access protected
+        *
+        * @param string $which Whether this is being invoked above ("top")
+        *                      or below the table ("bottom").
+        */
+       protected function extra_tablenav( $which ) {
                if ( 'top' != $which )
                        return;
                if ( 'top' != $which )
                        return;
-               if ( ! current_user_can( 'promote_users' ) )
-                       return;
-?>
+       ?>
        <div class="alignleft actions">
        <div class="alignleft actions">
+               <?php if ( current_user_can( 'promote_users' ) ) : ?>
                <label class="screen-reader-text" for="new_role"><?php _e( 'Change role to&hellip;' ) ?></label>
                <select name="new_role" id="new_role">
                <label class="screen-reader-text" for="new_role"><?php _e( 'Change role to&hellip;' ) ?></label>
                <select name="new_role" id="new_role">
-                       <option value=''><?php _e( 'Change role to&hellip;' ) ?></option>
+                       <option value=""><?php _e( 'Change role to&hellip;' ) ?></option>
                        <?php wp_dropdown_roles(); ?>
                </select>
                        <?php wp_dropdown_roles(); ?>
                </select>
-               <?php submit_button( __( 'Change' ), 'secondary', 'changeit', false ); ?>
-       </div>
-<?php
+       <?php
+                       submit_button( __( 'Change' ), 'button', 'changeit', false );
+               endif;
+
+               /**
+                * Fires just before the closing div containing the bulk role-change controls
+                * in the Users list table.
+                *
+                * @since 3.5.0
+                */
+               do_action( 'restrict_manage_users' );
+               echo '</div>';
        }
 
        }
 
-       function current_action() {
+       /**
+        * 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.
+        */
+       public function current_action() {
                if ( isset($_REQUEST['changeit']) && !empty($_REQUEST['new_role']) )
                        return 'promote';
 
                return parent::current_action();
        }
 
                if ( isset($_REQUEST['changeit']) && !empty($_REQUEST['new_role']) )
                        return 'promote';
 
                return parent::current_action();
        }
 
-       function get_columns() {
+       /**
+        * 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.
+        */
+       public function get_columns() {
                $c = array(
                        'cb'       => '<input type="checkbox" />',
                        'username' => __( 'Username' ),
                $c = array(
                        'cb'       => '<input type="checkbox" />',
                        'username' => __( 'Username' ),
@@ -173,7 +272,15 @@ class WP_Users_List_Table extends WP_List_Table {
                return $c;
        }
 
                return $c;
        }
 
-       function get_sortable_columns() {
+       /**
+        * Get a list of sortable columns for the list table.
+        *
+        * @since 3.1.0
+        * @access protected
+        *
+        * @return array Array of sortable columns.
+        */
+       protected function get_sortable_columns() {
                $c = array(
                        'username' => 'login',
                        'name'     => 'name',
                $c = array(
                        'username' => 'login',
                        'name'     => 'name',
@@ -186,39 +293,57 @@ class WP_Users_List_Table extends WP_List_Table {
                return $c;
        }
 
                return $c;
        }
 
-       function display_rows() {
+       /**
+        * Generate the list table rows.
+        *
+        * @since 3.1.0
+        * @access public
+        */
+       public function display_rows() {
                // Query the post counts for this page
                if ( ! $this->is_site_users )
                        $post_counts = count_many_users_posts( array_keys( $this->items ) );
 
                // Query the post counts for this page
                if ( ! $this->is_site_users )
                        $post_counts = count_many_users_posts( array_keys( $this->items ) );
 
-               $style = '';
+               $editable_roles = array_keys( get_editable_roles() );
+
                foreach ( $this->items as $userid => $user_object ) {
                foreach ( $this->items as $userid => $user_object ) {
-                       $role = reset( $user_object->roles );
+                       if ( count( $user_object->roles ) <= 1 ) {
+                               $role = reset( $user_object->roles );
+                       } elseif ( $roles = array_intersect( array_values( $user_object->roles ), $editable_roles ) ) {
+                               $role = reset( $roles );
+                       } else {
+                               $role = reset( $user_object->roles );
+                       }
 
 
-                       if ( is_multisite() && empty( $role ) )
+                       if ( is_multisite() && empty( $user_object->allcaps ) )
                                continue;
 
                                continue;
 
-                       $style = ( ' class="alternate"' == $style ) ? '' : ' class="alternate"';
-                       echo "\n\t", $this->single_row( $user_object, $style, $role, isset( $post_counts ) ? $post_counts[ $userid ] : 0 );
+                       echo "\n\t" . $this->single_row( $user_object, $style = '', $role, isset( $post_counts ) ? $post_counts[ $userid ] : 0 );
                }
        }
 
        /**
         * Generate HTML for a single row on the users.php admin panel.
         *
                }
        }
 
        /**
         * Generate HTML for a single row on the users.php admin panel.
         *
-        * @since 2.1.0
+        * @since 3.1.0
+        * @since 4.2.0 The `$style` argument was deprecated.
+        * @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
+        * @global WP_Roles $wp_roles User roles object.
+        *
+        * @param object $user_object The current user object.
+        * @param string $style       Deprecated. Not used.
+        * @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 ) {
+       public function single_row( $user_object, $style = '', $role = '', $numposts = 0 ) {
                global $wp_roles;
 
                global $wp_roles;
 
-               if ( !( is_object( $user_object ) && is_a( $user_object, 'WP_User' ) ) )
-                       $user_object = new WP_User( (int) $user_object );
+               if ( ! ( $user_object instanceof WP_User ) ) {
+                       $user_object = get_userdata( (int) $user_object );
+               }
                $user_object->filter = 'display';
                $email = $user_object->user_email;
 
                $user_object->filter = 'display';
                $email = $user_object->user_email;
 
@@ -231,12 +356,7 @@ class WP_Users_List_Table extends WP_List_Table {
                // Check if the user for this row is editable
                if ( current_user_can( 'list_users' ) ) {
                        // Set up the user editing link
                // Check if the user for this row is editable
                if ( current_user_can( 'list_users' ) ) {
                        // Set up the user editing link
-                       // TODO: make profile/user-edit determination a separate function
-                       if ( get_current_user_id() == $user_object->ID ) {
-                               $edit_link = 'profile.php';
-                       } else {
-                               $edit_link = esc_url( add_query_arg( 'wp_http_referer', urlencode( stripslashes( $_SERVER['REQUEST_URI'] ) ), "user-edit.php?user_id=$user_object->ID" ) );
-                       }
+                       $edit_link = esc_url( add_query_arg( 'wp_http_referer', urlencode( wp_unslash( $_SERVER['REQUEST_URI'] ) ), get_edit_user_link( $user_object->ID ) ) );
 
                        // Set up the hover actions for this user
                        $actions = array();
 
                        // Set up the hover actions for this user
                        $actions = array();
@@ -252,11 +372,23 @@ class WP_Users_List_Table extends WP_List_Table {
                                $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>";
                                $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>";
+
+                       /**
+                        * Filter the action links displayed under each user in the Users list table.
+                        *
+                        * @since 2.8.0
+                        *
+                        * @param array   $actions     An array of action links to be displayed.
+                        *                             Default 'Edit', 'Delete' for single site, and
+                        *                             'Edit', 'Remove' for Multisite.
+                        * @param WP_User $user_object WP_User object for the currently-listed user.
+                        */
                        $actions = apply_filters( 'user_row_actions', $actions, $user_object );
                        $edit .= $this->row_actions( $actions );
 
                        $actions = apply_filters( 'user_row_actions', $actions, $user_object );
                        $edit .= $this->row_actions( $actions );
 
-                       // Set up the checkbox ( because the user is editable, otherwise its empty )
-                       $checkbox = "<input type='checkbox' name='users[]' id='user_{$user_object->ID}' class='$role' value='{$user_object->ID}' />";
+                       // Set up the checkbox ( because the user is editable, otherwise it's empty )
+                       $checkbox = '<label class="screen-reader-text" for="user_' . $user_object->ID . '">' . sprintf( __( 'Select %s' ), $user_object->user_login ) . '</label>'
+                                               . "<input type='checkbox' name='users[]' id='user_{$user_object->ID}' class='$role' value='{$user_object->ID}' />";
 
                } else {
                        $edit = '<strong>' . $user_object->user_login . '</strong>';
 
                } else {
                        $edit = '<strong>' . $user_object->user_login . '</strong>';
@@ -264,7 +396,7 @@ class WP_Users_List_Table extends WP_List_Table {
                $role_name = isset( $wp_roles->role_names[$role] ) ? translate_user_role( $wp_roles->role_names[$role] ) : __( 'None' );
                $avatar = get_avatar( $user_object->ID, 32 );
 
                $role_name = isset( $wp_roles->role_names[$role] ) ? translate_user_role( $wp_roles->role_names[$role] ) : __( 'None' );
                $avatar = get_avatar( $user_object->ID, 32 );
 
-               $r = "<tr id='user-$user_object->ID'$style>";
+               $r = "<tr id='user-$user_object->ID'>";
 
                list( $columns, $hidden ) = $this->get_column_info();
 
 
                list( $columns, $hidden ) = $this->get_column_info();
 
@@ -307,6 +439,16 @@ class WP_Users_List_Table extends WP_List_Table {
                                        break;
                                default:
                                        $r .= "<td $attributes>";
                                        break;
                                default:
                                        $r .= "<td $attributes>";
+
+                                       /**
+                                        * Filter the display output of custom columns in the Users list table.
+                                        *
+                                        * @since 2.8.0
+                                        *
+                                        * @param string $output      Custom column output. Default empty.
+                                        * @param string $column_name Column name.
+                                        * @param int    $user_id     ID of the currently-listed user.
+                                        */
                                        $r .= apply_filters( 'manage_users_custom_column', '', $column_name, $user_object->ID );
                                        $r .= "</td>";
                        }
                                        $r .= apply_filters( 'manage_users_custom_column', '', $column_name, $user_object->ID );
                                        $r .= "</td>";
                        }