enmi-conf.org: comparison wp/wp-admin/includes/class-wp-users-list-table.php

equal deleted inserted replaced

-:490d5cc509ed
+:cf61fcea0001
 <?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
 *
-* @package WordPress
+* @see WP_List_Table
-* @subpackage List_Table
 */
 class WP_Users_List_Table extends WP_List_Table {
 	/**
 	 * Site ID to generate the Users list table for.
 	 *
 	 * @since 3.1.0
-	 * @access public
 	 * @var int
 	 */
 	public $site_id;
 	/**
 	 * 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.
 	 */
 			'singular' => 'user',
 			'plural'   => 'users',
 			'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;
 	}
 	/**
 	 * Check the current user's permissions.
 	 *
 	 * @since 3.1.0
-	 * @access public
+	 *
+	 * @return bool
 	 */
 	public function ajax_user_can() {
 		if ( $this->is_site_users )
 			return current_user_can( 'manage_sites' );
 		else
 	/**
 	 * Prepare the users list for display.
 	 *
 	 * @since 3.1.0
-	 * @access public
+	 *
+	 * @global string $role
+	 * @global string $usersearch
 	 */
 	public function prepare_items() {
 		global $role, $usersearch;
 		$usersearch = isset( $_REQUEST['s'] ) ? wp_unslash( trim( $_REQUEST['s'] ) ) : '';
 		$per_page = ( $this->is_site_users ) ? 'site_users_network_per_page' : 'users_per_page';
 		$users_per_page = $this->get_items_per_page( $per_page );
 		$paged = $this->get_pagenum();
-		$args = array(
+		if ( 'none' === $role ) {
-			'number' => $users_per_page,
+			$args = array(
-			'offset' => ( $paged-1 ) * $users_per_page,
+				'number' => $users_per_page,
-			'role' => $role,
+				'offset' => ( $paged-1 ) * $users_per_page,
-			'search' => $usersearch,
+				'include' => wp_get_users_with_no_role( $this->site_id ),
-			'fields' => 'all_with_meta'
+				'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 ( $this->is_site_users )
 		if ( isset( $_REQUEST['orderby'] ) )
 			$args['orderby'] = $_REQUEST['orderby'];
 		if ( isset( $_REQUEST['order'] ) )
 			$args['order'] = $_REQUEST['order'];
+		/**
+		 * Filters 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 );
 		$this->items = $wp_user_search->get_results();
 	/**
 	 * Output 'no users' message.
 	 *
 	 * @since 3.1.0
-	 * @access public
 	 */
 	public function no_items() {
 		_e( 'No users 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
-	 * filtering of the user table.
+	 * Filtersing of the user table.
 	 *
 	 * @since  3.1.0
-	 * @access protected
+	 *
+	 * @global string $role
 	 *
 	 * @return array An array of HTML links, one for each view.
 	 */
 	protected function get_views() {
-		global $wp_roles, $role;
+		global $role;
+		$wp_roles = wp_roles();
 		if ( $this->is_site_users ) {
 			$url = 'site-users.php?id=' . $this->site_id;
 			switch_to_blog( $this->site_id );
-			$users_of_blog = count_users();
+			$users_of_blog = count_users( 'time', $this->site_id );
 			restore_current_blog();
 		} else {
 			$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);
-		$class = empty($role) ? ' class="current"' : '';
+		$current_link_attributes = empty( $role ) ? ' class="current" aria-current="page"' : '';
 		$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>';
+		$role_links['all'] = "<a href='$url'$current_link_attributes>" . sprintf( _nx( 'All <span class="count">(%s)</span>', 'All <span class="count">(%s)</span>', $total_users, 'users' ), number_format_i18n( $total_users ) ) . '</a>';
 		foreach ( $wp_roles->get_names() as $this_role => $name ) {
 			if ( !isset($avail_roles[$this_role]) )
 				continue;
-			$class = '';
+			$current_link_attributes = '';
-			if ( $this_role == $role ) {
+			if ( $this_role === $role ) {
-				$class = ' class="current"';
+				$current_link_attributes = ' class="current" aria-current="page"';
 			}
 			$name = translate_user_role( $name );
 			/* translators: User role name with count */
 			$name = sprintf( __('%1$s <span class="count">(%2$s)</span>'), $name, number_format_i18n( $avail_roles[$this_role] ) );
-			$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 ) ) . "'$current_link_attributes>$name</a>";
+		}
+		if ( ! empty( $avail_roles['none' ] ) ) {
+			$current_link_attributes = '';
+			if ( 'none' === $role ) {
+				$current_link_attributes = ' class="current" aria-current="page"';
+			}
+			$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 ) ) . "'$current_link_attributes>$name</a>";
 		}
 		return $role_links;
 	}
 	/**
 	 * 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();
 	/**
 	 * 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 )
+		$id = 'bottom' === $which ? 'new_role2' : 'new_role';
-			return;
+		$button_id = 'bottom' === $which ? 'changeit2' : 'changeit';
 	?>
 	<div class="alignleft actions">
-		<?php if ( current_user_can( 'promote_users' ) ) : ?>
+		<?php if ( current_user_can( 'promote_users' ) && $this->has_items() ) : ?>
-		<label class="screen-reader-text" for="new_role"><?php _e( 'Change role to&hellip;' ) ?></label>
+		<label class="screen-reader-text" for="<?php echo $id ?>"><?php _e( 'Change role to&hellip;' ) ?></label>
-		<select name="new_role" id="new_role">
+		<select name="<?php echo $id ?>" id="<?php echo $id ?>">
 			<option value=""><?php _e( 'Change role to&hellip;' ) ?></option>
 			<?php wp_dropdown_roles(); ?>
 		</select>
 	<?php
-			submit_button( __( 'Change' ), 'button', 'changeit', false );
+			submit_button( __( 'Change' ), '', $button_id, false );
 		endif;
 		/**
 		 * Fires just before the closing div containing the bulk role-change controls
 		 * in the Users list table.
 		 *
 		 * @since 3.5.0
+		 * @since 4.6.0 The `$which` parameter was added.
+		 *
+		 * @param string $which The location of the extra table nav markup: 'top' or 'bottom'.
 		 */
-		do_action( 'restrict_manage_users' );
+		do_action( 'restrict_manage_users', $which );
-		echo '</div>';
+	?>
+		</div>
+	<?php
+		/**
+		 * Fires immediately following the closing "actions" div in the tablenav for the users
+		 * list table.
+		 *
+		 * @since 4.9.0
+		 *
+		 * @param string $which The location of the extra table nav markup: 'top' or 'bottom'.
+		 */
+		do_action( 'manage_users_extra_tablenav', $which );
 	}
 	/**
 	 * 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']) )
+		if ( ( isset( $_REQUEST['changeit'] ) || isset( $_REQUEST['changeit2'] ) ) &&
+			( ! empty( $_REQUEST['new_role'] ) || ! empty( $_REQUEST['new_role2'] ) ) ) {
 			return 'promote';
+		}
 		return parent::current_action();
 	}
 	/**
 	 * 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' ),
 			'name'     => __( 'Name' ),
-			'email'    => __( 'E-mail' ),
+			'email'    => __( 'Email' ),
 			'role'     => __( 'Role' ),
 			'posts'    => __( 'Posts' )
 		);
 		if ( $this->is_site_users )
 	/**
 	 * 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',
 			'email'    => 'email',
 		);
-		if ( $this->is_site_users )
-			unset( $c['posts'] );
 		return $c;
 	}
 	/**
 	 * 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 ) );
-		$editable_roles = array_keys( get_editable_roles() );
 		foreach ( $this->items as $userid => $user_object ) {
-			if ( count( $user_object->roles ) <= 1 ) {
+			echo "\n\t" . $this->single_row( $user_object, '', '', isset( $post_counts ) ? $post_counts[ $userid ] : 0 );
-				$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;
-			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.
 	 *
 	 * @since 3.1.0
-	 * @since 4.2.0 The `$style` argument was deprecated.
+	 * @since 4.2.0 The `$style` parameter was deprecated.
-	 * @access public
+	 * @since 4.4.0 The `$role` parameter was deprecated.
 	 *
-	 * @global WP_Roles $wp_roles User roles object.
+	 * @param WP_User $user_object The current user object.
-	 *
+	 * @param string  $style       Deprecated. Not used.
-	 * @param object $user_object The current user object.
+	 * @param string  $role        Deprecated. Not used.
-	 * @param string $style       Deprecated. Not used.
+	 * @param int     $numposts    Optional. Post count to display for this user. Defaults
-	 * @param string $role        Optional. Key for the $wp_roles array. Default empty.
+	 *                             to zero, as in, a new user has made zero posts.
-	 * @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 ) {
-		global $wp_roles;
 		if ( ! ( $user_object instanceof WP_User ) ) {
 			$user_object = get_userdata( (int) $user_object );
 		}
 		$user_object->filter = 'display';
 		$email = $user_object->user_email;
 		if ( $this->is_site_users )
 			$url = "site-users.php?id={$this->site_id}&amp;";
 		else
 			$url = 'users.php?';
+		$user_roles = $this->get_role_list( $user_object );
+		// Set up the hover actions for this user
+		$actions = array();
 		$checkbox = '';
+		$super_admin = '';
+		if ( is_multisite() && current_user_can( 'manage_network_users' ) ) {
+			if ( in_array( $user_object->user_login, get_super_admins(), true ) ) {
+				$super_admin = ' &mdash; ' . __( 'Super Admin' );
+			}
+		}
 		// 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 />";
+				$edit = "<strong><a href=\"{$edit_link}\">{$user_object->user_login}</a>{$super_admin}</strong><br />";
 				$actions['edit'] = '<a href="' . $edit_link . '">' . __( 'Edit' ) . '</a>';
 			} else {
-				$edit = "<strong>$user_object->user_login</strong><br />";
+				$edit = "<strong>{$user_object->user_login}{$super_admin}</strong><br />";
 			}
 			if ( !is_multisite() && get_current_user_id() != $user_object->ID && current_user_can( 'delete_user', $user_object->ID ) )
 				$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>";
+			// Add a link to the user's author archive, if not empty.
+			$author_posts_url = get_author_posts_url( $user_object->ID );
+			if ( $author_posts_url ) {
+				$actions['view'] = sprintf(
+					'<a href="%s" aria-label="%s">%s</a>',
+					esc_url( $author_posts_url ),
+					/* translators: %s: author's display name */
+					esc_attr( sprintf( __( 'View posts by %s' ), $user_object->display_name ) ),
+					__( 'View' )
+				);
+			}
 			/**
-			 * Filter the action links displayed under each user in the Users list table.
+			 * Filters 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 );
+			// 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>'
-						. "<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>';
+			$edit = "<strong>{$user_object->user_login}{$super_admin}</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 );
+		// Comma-separated list of user roles.
+		$roles_list = implode( ', ', $user_roles );
 		$r = "<tr id='user-$user_object->ID'>";
-		list( $columns, $hidden ) = $this->get_column_info();
+		list( $columns, $hidden, $sortable, $primary ) = $this->get_column_info();
 		foreach ( $columns as $column_name => $column_display_name ) {
-			$class = "class=\"$column_name column-$column_name\"";
+			$classes = "$column_name column-$column_name";
+			if ( $primary === $column_name ) {
-			$style = '';
+				$classes .= ' has-row-actions column-primary';
-			if ( in_array( $column_name, $hidden ) )
+			}
-				$style = ' style="display:none;"';
+			if ( 'posts' === $column_name ) {
+				$classes .= ' num'; // Special case for that column
-			$attributes = "$class$style";
+			}
-			switch ( $column_name ) {
+			if ( in_array( $column_name, $hidden ) ) {
-				case 'cb':
+				$classes .= ' hidden';
-					$r .= "<th scope='row' class='check-column'>$checkbox</th>";
+			}
-					break;
-				case 'username':
+			$data = 'data-colname="' . wp_strip_all_tags( $column_display_name ) . '"';
-					$r .= "<td $attributes>$avatar $edit</td>";
-					break;
+			$attributes = "class='$classes' $data";
-				case 'name':
-					$r .= "<td $attributes>$user_object->first_name $user_object->last_name</td>";
+			if ( 'cb' === $column_name ) {
-					break;
+				$r .= "<th scope='row' class='check-column'>$checkbox</th>";
-				case 'email':
+			} else {
-					$r .= "<td $attributes><a href='mailto:$email' title='" . esc_attr( sprintf( __( 'E-mail: %s' ), $email ) ) . "'>$email</a></td>";
+				$r .= "<td $attributes>";
-					break;
+				switch ( $column_name ) {
-				case 'role':
+					case 'username':
-					$r .= "<td $attributes>$role_name</td>";
+						$r .= "$avatar $edit";
-					break;
+						break;
-				case 'posts':
+					case 'name':
-					$attributes = 'class="posts column-posts num"' . $style;
+						if ( $user_object->first_name && $user_object->last_name ) {
-					$r .= "<td $attributes>";
+							$r .= "$user_object->first_name $user_object->last_name";
-					if ( $numposts > 0 ) {
+						} elseif ( $user_object->first_name ) {
-						$r .= "<a href='edit.php?author=$user_object->ID' title='" . esc_attr__( 'View posts by this author' ) . "' class='edit'>";
+							$r .= $user_object->first_name;
-						$r .= $numposts;
+						} elseif ( $user_object->last_name ) {
-						$r .= '</a>';
+							$r .= $user_object->last_name;
-					} else {
+						} else {
-						$r .= 0;
+							$r .= '<span aria-hidden="true">&#8212;</span><span class="screen-reader-text">' . _x( 'Unknown', 'name' ) . '</span>';
-					}
+						}
-					$r .= "</td>";
+						break;
-					break;
+					case 'email':
-				default:
+						$r .= "<a href='" . esc_url( "mailto:$email" ) . "'>$email</a>";
-					$r .= "<td $attributes>";
+						break;
+					case 'role':
-					/**
+						$r .= esc_html( $roles_list );
-					 * Filter the display output of custom columns in the Users list table.
+						break;
-					 *
+					case 'posts':
-					 * @since 2.8.0
+						if ( $numposts > 0 ) {
-					 *
+							$r .= "<a href='edit.php?author=$user_object->ID' class='edit'>";
-					 * @param string $output      Custom column output. Default empty.
+							$r .= '<span aria-hidden="true">' . $numposts . '</span>';
-					 * @param string $column_name Column name.
+							$r .= '<span class="screen-reader-text">' . sprintf( _n( '%s post by this author', '%s posts by this author', $numposts ), number_format_i18n( $numposts ) ) . '</span>';
-					 * @param int    $user_id     ID of the currently-listed user.
+							$r .= '</a>';
-					 */
+						} else {
-					$r .= apply_filters( 'manage_users_custom_column', '', $column_name, $user_object->ID );
+							$r .= 0;
-					$r .= "</td>";
+						}
+						break;
+					default:
+						/**
+						 * Filters 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 );
+				}
+				if ( $primary === $column_name ) {
+					$r .= $this->row_actions( $actions );
+				}
+				$r .= "</td>";
 			}
 		}
 		$r .= '</tr>';
 		return $r;
 	}
+	/**
+	 * Gets the name of the default primary column.
+	 *
+	 * @since 4.3.0
+	 *
+	 * @return string Name of the default primary column, in this case, '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
+	 *
+	 * @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' );
+		}
+		/**
+		 * Filters 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 );
+	}
 }

changeset 7	cf61fcea0001
parent 5	5e2f62d02dcd
child 9	177826044cd9