WordPress 4.4
[autoinstalls/wordpress.git] / wp-admin / includes / class-wp-users-list-table.php
index bb83f85672052b0a49bfb3c010d40a821b8bfe4c..9e26867df95fde4151bb833b368d87abb3dcb98e 100644 (file)
@@ -1,12 +1,19 @@
 <?php
 /**
 <?php
 /**
- * Users List Table class.
+ * List Table API: WP_Users_List_Table class
+ *
+ * @package WordPress
+ * @subpackage Administration
+ * @since 3.1.0
+ */
+
+/**
+ * Core class used to implement displaying users in a list table.
  *
  * @since 3.1.0
  * @access private
  *
  *
  * @since 3.1.0
  * @access private
  *
- * @package WordPress
- * @subpackage List_Table
+ * @see WP_List_Table
  */
 class WP_Users_List_Table extends WP_List_Table {
 
  */
 class WP_Users_List_Table extends WP_List_Table {
 
@@ -45,7 +52,7 @@ class WP_Users_List_Table extends WP_List_Table {
                        'screen'   => isset( $args['screen'] ) ? $args['screen'] : null,
                ) );
 
                        'screen'   => isset( $args['screen'] ) ? $args['screen'] : null,
                ) );
 
-               $this->is_site_users = 'site-users-network' == $this->screen->id;
+               $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;
 
                if ( $this->is_site_users )
                        $this->site_id = isset( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : 0;
@@ -87,13 +94,23 @@ class WP_Users_List_Table extends WP_List_Table {
 
                $paged = $this->get_pagenum();
 
 
                $paged = $this->get_pagenum();
 
-               $args = array(
-                       'number' => $users_per_page,
-                       'offset' => ( $paged-1 ) * $users_per_page,
-                       'role' => $role,
-                       'search' => $usersearch,
-                       'fields' => 'all_with_meta'
-               );
+               if ( 'none' === $role ) {
+                       $args = array(
+                               'number' => $users_per_page,
+                               'offset' => ( $paged-1 ) * $users_per_page,
+                               'include' => wp_get_users_with_no_role(),
+                               'search' => $usersearch,
+                               'fields' => 'all_with_meta'
+                       );
+               } else {
+                       $args = array(
+                               'number' => $users_per_page,
+                               'offset' => ( $paged-1 ) * $users_per_page,
+                               'role' => $role,
+                               'search' => $usersearch,
+                               'fields' => 'all_with_meta'
+                       );
+               }
 
                if ( '' !== $args['search'] )
                        $args['search'] = '*' . $args['search'] . '*';
 
                if ( '' !== $args['search'] )
                        $args['search'] = '*' . $args['search'] . '*';
@@ -107,6 +124,16 @@ class WP_Users_List_Table extends WP_List_Table {
                if ( isset( $_REQUEST['order'] ) )
                        $args['order'] = $_REQUEST['order'];
 
                if ( isset( $_REQUEST['order'] ) )
                        $args['order'] = $_REQUEST['order'];
 
+               /**
+                * Filter the query arguments used to retrieve users for the current users list table.
+                *
+                * @since 4.4.0
+                *
+                * @param array $args Arguments passed to WP_User_Query to retrieve items for the current
+                *                    users list table.
+                */
+               $args = apply_filters( 'users_list_table_query_args', $args );
+
                // Query the user IDs for this page
                $wp_user_search = new WP_User_Query( $args );
 
                // Query the user IDs for this page
                $wp_user_search = new WP_User_Query( $args );
 
@@ -156,6 +183,7 @@ class WP_Users_List_Table extends WP_List_Table {
                        $url = 'users.php';
                        $users_of_blog = count_users();
                }
                        $url = 'users.php';
                        $users_of_blog = count_users();
                }
+
                $total_users = $users_of_blog['total_users'];
                $avail_roles =& $users_of_blog['avail_roles'];
                unset($users_of_blog);
                $total_users = $users_of_blog['total_users'];
                $avail_roles =& $users_of_blog['avail_roles'];
                unset($users_of_blog);
@@ -169,7 +197,7 @@ class WP_Users_List_Table extends WP_List_Table {
 
                        $class = '';
 
 
                        $class = '';
 
-                       if ( $this_role == $role ) {
+                       if ( $this_role === $role ) {
                                $class = ' class="current"';
                        }
 
                                $class = ' class="current"';
                        }
 
@@ -179,6 +207,21 @@ class WP_Users_List_Table extends WP_List_Table {
                        $role_links[$this_role] = "<a href='" . esc_url( add_query_arg( 'role', $this_role, $url ) ) . "'$class>$name</a>";
                }
 
                        $role_links[$this_role] = "<a href='" . esc_url( add_query_arg( 'role', $this_role, $url ) ) . "'$class>$name</a>";
                }
 
+               if ( ! empty( $avail_roles['none' ] ) ) {
+
+                       $class = '';
+
+                       if ( 'none' === $role ) {
+                               $class = ' class="current"';
+                       }
+
+                       $name = __( 'No role' );
+                       /* translators: User role name with count */
+                       $name = sprintf( __('%1$s <span class="count">(%2$s)</span>'), $name, number_format_i18n( $avail_roles['none' ] ) );
+                       $role_links['none'] = "<a href='" . esc_url( add_query_arg( 'role', 'none', $url ) ) . "'$class>$name</a>";
+
+               }
+
                return $role_links;
        }
 
                return $role_links;
        }
 
@@ -214,13 +257,12 @@ class WP_Users_List_Table extends WP_List_Table {
         *                      or below the table ("bottom").
         */
        protected function extra_tablenav( $which ) {
         *                      or below the table ("bottom").
         */
        protected function extra_tablenav( $which ) {
-               if ( 'top' != $which )
-                       return;
+               $id = 'bottom' === $which ? 'new_role2' : 'new_role';
        ?>
        <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">
+               <?php if ( current_user_can( 'promote_users' ) && $this->has_items() ) : ?>
+               <label class="screen-reader-text" for="<?php echo $id ?>"><?php _e( 'Change role to&hellip;' ) ?></label>
+               <select name="<?php echo $id ?>" id="<?php echo $id ?>">
                        <option value=""><?php _e( 'Change role to&hellip;' ) ?></option>
                        <?php wp_dropdown_roles(); ?>
                </select>
                        <option value=""><?php _e( 'Change role to&hellip;' ) ?></option>
                        <?php wp_dropdown_roles(); ?>
                </select>
@@ -250,8 +292,10 @@ class WP_Users_List_Table extends WP_List_Table {
         * @return string The bulk action required.
         */
        public function current_action() {
         * @return string The bulk action required.
         */
        public function current_action() {
-               if ( isset($_REQUEST['changeit']) && !empty($_REQUEST['new_role']) )
+               if ( isset( $_REQUEST['changeit'] ) &&
+                       ( ! empty( $_REQUEST['new_role'] ) || ! empty( $_REQUEST['new_role2'] ) ) ) {
                        return 'promote';
                        return 'promote';
+               }
 
                return parent::current_action();
        }
 
                return parent::current_action();
        }
@@ -270,7 +314,7 @@ class WP_Users_List_Table extends WP_List_Table {
                        'cb'       => '<input type="checkbox" />',
                        'username' => __( 'Username' ),
                        'name'     => __( 'Name' ),
                        'cb'       => '<input type="checkbox" />',
                        'username' => __( 'Username' ),
                        'name'     => __( 'Name' ),
-                       'email'    => __( 'E-mail' ),
+                       'email'    => __( 'Email' ),
                        'role'     => __( 'Role' ),
                        'posts'    => __( 'Posts' )
                );
                        'role'     => __( 'Role' ),
                        'posts'    => __( 'Posts' )
                );
@@ -296,9 +340,6 @@ class WP_Users_List_Table extends WP_List_Table {
                        'email'    => 'email',
                );
 
                        'email'    => 'email',
                );
 
-               if ( $this->is_site_users )
-                       unset( $c['posts'] );
-
                return $c;
        }
 
                return $c;
        }
 
@@ -313,21 +354,11 @@ class WP_Users_List_Table extends WP_List_Table {
                if ( ! $this->is_site_users )
                        $post_counts = count_many_users_posts( array_keys( $this->items ) );
 
                if ( ! $this->is_site_users )
                        $post_counts = count_many_users_posts( array_keys( $this->items ) );
 
-               $editable_roles = array_keys( get_editable_roles() );
-
                foreach ( $this->items as $userid => $user_object ) {
                foreach ( $this->items as $userid => $user_object ) {
-                       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( $user_object->allcaps ) )
                                continue;
 
                        if ( is_multisite() && empty( $user_object->allcaps ) )
                                continue;
 
-                       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, '', '', isset( $post_counts ) ? $post_counts[ $userid ] : 0 );
                }
        }
 
                }
        }
 
@@ -335,19 +366,18 @@ class WP_Users_List_Table extends WP_List_Table {
         * Generate HTML for a single row on the users.php admin panel.
         *
         * @since 3.1.0
         * Generate HTML for a single row on the users.php admin panel.
         *
         * @since 3.1.0
-        * @since 4.2.0 The `$style` argument was deprecated.
+        * @since 4.2.0 The `$style` parameter was deprecated.
+        * @since 4.4.0 The `$role` parameter was deprecated.
         * @access public
         *
         * @param object $user_object The current user object.
         * @param string $style       Deprecated. Not used.
         * @access public
         *
         * @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 string $role        Deprecated. Not used.
         * @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.
         */
        public function single_row( $user_object, $style = '', $role = '', $numposts = 0 ) {
         * @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.
         */
        public function single_row( $user_object, $style = '', $role = '', $numposts = 0 ) {
-               $wp_roles = wp_roles();
-
                if ( ! ( $user_object instanceof WP_User ) ) {
                        $user_object = get_userdata( (int) $user_object );
                }
                if ( ! ( $user_object instanceof WP_User ) ) {
                        $user_object = get_userdata( (int) $user_object );
                }
@@ -359,15 +389,16 @@ class WP_Users_List_Table extends WP_List_Table {
                else
                        $url = 'users.php?';
 
                else
                        $url = 'users.php?';
 
+               $user_roles = $this->get_role_list( $user_object );
+
+               // Set up the hover actions for this user
+               $actions = array();
                $checkbox = '';
                // Check if the user for this row is editable
                if ( current_user_can( 'list_users' ) ) {
                        // Set up the user editing link
                        $edit_link = esc_url( add_query_arg( 'wp_http_referer', urlencode( wp_unslash( $_SERVER['REQUEST_URI'] ) ), get_edit_user_link( $user_object->ID ) ) );
 
                $checkbox = '';
                // Check if the user for this row is editable
                if ( current_user_can( 'list_users' ) ) {
                        // Set up the user editing link
                        $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();
-
                        if ( current_user_can( 'edit_user',  $user_object->ID ) ) {
                                $edit = "<strong><a href=\"$edit_link\">$user_object->user_login</a></strong><br />";
                                $actions['edit'] = '<a href="' . $edit_link . '">' . __( 'Edit' ) . '</a>';
                        if ( current_user_can( 'edit_user',  $user_object->ID ) ) {
                                $edit = "<strong><a href=\"$edit_link\">$user_object->user_login</a></strong><br />";
                                $actions['edit'] = '<a href="' . $edit_link . '">' . __( 'Edit' ) . '</a>';
@@ -392,16 +423,21 @@ class WP_Users_List_Table extends WP_List_Table {
                         */
                        $actions = apply_filters( 'user_row_actions', $actions, $user_object );
 
                         */
                        $actions = apply_filters( 'user_row_actions', $actions, $user_object );
 
+                       // Role classes.
+                       $role_classes = esc_attr( implode( ' ', array_keys( $user_roles ) ) );
+
                        // 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>'
                        // 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}' />";
+                                               . "<input type='checkbox' name='users[]' id='user_{$user_object->ID}' class='{$role_classes}' value='{$user_object->ID}' />";
 
                } else {
                        $edit = '<strong>' . $user_object->user_login . '</strong>';
                }
 
                } else {
                        $edit = '<strong>' . $user_object->user_login . '</strong>';
                }
-               $role_name = isset( $wp_roles->role_names[$role] ) ? translate_user_role( $wp_roles->role_names[$role] ) : __( 'None' );
                $avatar = get_avatar( $user_object->ID, 32 );
 
                $avatar = get_avatar( $user_object->ID, 32 );
 
+               // Comma-separated list of user roles.
+               $roles_list = implode( ', ', $user_roles );
+
                $r = "<tr id='user-$user_object->ID'>";
 
                list( $columns, $hidden, $sortable, $primary ) = $this->get_column_info();
                $r = "<tr id='user-$user_object->ID'>";
 
                list( $columns, $hidden, $sortable, $primary ) = $this->get_column_info();
@@ -438,7 +474,7 @@ class WP_Users_List_Table extends WP_List_Table {
                                                $r .= "<a href='" . esc_url( "mailto:$email" ) . "'>$email</a>";
                                                break;
                                        case 'role':
                                                $r .= "<a href='" . esc_url( "mailto:$email" ) . "'>$email</a>";
                                                break;
                                        case 'role':
-                                               $r .= $role_name;
+                                               $r .= esc_html( $roles_list );
                                                break;
                                        case 'posts':
                                                if ( $numposts > 0 ) {
                                                break;
                                        case 'posts':
                                                if ( $numposts > 0 ) {
@@ -485,4 +521,40 @@ class WP_Users_List_Table extends WP_List_Table {
        protected function get_default_primary_column_name() {
                return 'username';
        }
        protected function get_default_primary_column_name() {
                return 'username';
        }
+
+       /**
+        * Returns an array of user roles for a given user object.
+        *
+        * @since 4.4.0
+        * @access protected
+        *
+        * @param WP_User $user_object The WP_User object.
+        * @return array An array of user roles.
+        */
+       protected function get_role_list( $user_object ) {
+               $wp_roles = wp_roles();
+
+               $role_list = array();
+
+               foreach ( $user_object->roles as $role ) {
+                       if ( isset( $wp_roles->role_names[ $role ] ) ) {
+                               $role_list[ $role ] = translate_user_role( $wp_roles->role_names[ $role ] );
+                       }
+               }
+
+               if ( empty( $role_list ) ) {
+                       $role_list['none'] = _x( 'None', 'no user roles' );
+               }
+
+               /**
+                * Filter the returned array of roles for a user.
+                *
+                * @since 4.4.0
+                *
+                * @param array   $role_list   An array of user roles.
+                * @param WP_User $user_object A WP_User object.
+                */
+               return apply_filters( 'get_role_list', $role_list, $user_object );
+       }
+
 }
 }