X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/f9001779751f83dc8a10e478bfecb4d8dd5f964c..dc1231b7312fbdca99e9e887cc2bb35a28f85cdc:/wp-admin/includes/class-wp-users-list-table.php diff --git a/wp-admin/includes/class-wp-users-list-table.php b/wp-admin/includes/class-wp-users-list-table.php index d52d75f0..bb83f856 100644 --- a/wp-admin/includes/class-wp-users-list-table.php +++ b/wp-admin/includes/class-wp-users-list-table.php @@ -2,40 +2,83 @@ /** * Users List Table class. * - * @package WordPress - * @subpackage List_Table * @since 3.1.0 * @access private + * + * @package WordPress + * @subpackage List_Table */ class WP_Users_List_Table extends WP_List_Table { - var $site_id; - var $is_site_users; - - function WP_Users_List_Table() { - $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; - parent::WP_List_Table( array( + /** + * 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', - '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 + * + * @return bool + */ + public function ajax_user_can() { 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 + * + * @global string $role + * @global string $usersearch + */ + public function prepare_items() { global $role, $usersearch; - $usersearch = isset( $_REQUEST['s'] ) ? $_REQUEST['s'] : ''; + $usersearch = isset( $_REQUEST['s'] ) ? wp_unslash( trim( $_REQUEST['s'] ) ) : ''; $role = isset( $_REQUEST['role'] ) ? $_REQUEST['role'] : ''; @@ -52,7 +95,8 @@ class WP_Users_List_Table extends WP_List_Table { 'fields' => 'all_with_meta' ); - $args['search'] = '*' . $args['search'] . '*'; + if ( '' !== $args['search'] ) + $args['search'] = '*' . $args['search'] . '*'; if ( $this->is_site_users ) $args['blog_id'] = $this->site_id; @@ -74,12 +118,34 @@ 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() { - global $wp_roles, $role; + /** + * 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 + * + * @global string $role + * + * @return array An array of HTML links, one for each view. + */ + protected function get_views() { + global $role; + + $wp_roles = wp_roles(); if ( $this->is_site_users ) { $url = 'site-users.php?id=' . $this->site_id; @@ -94,7 +160,6 @@ class WP_Users_List_Table extends WP_List_Table { $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'] = "" . sprintf( _nx( 'All (%s)', 'All (%s)', $total_users, 'users' ), number_format_i18n( $total_users ) ) . ''; @@ -105,20 +170,27 @@ class WP_Users_List_Table extends WP_List_Table { $class = ''; if ( $this_role == $role ) { - $current_role = $role; $class = ' class="current"'; } $name = translate_user_role( $name ); /* translators: User role name with count */ - $name = sprintf( __('%1$s (%2$s)'), $name, $avail_roles[$this_role] ); - $role_links[$this_role] = "$name"; + $name = sprintf( __('%1$s (%2$s)'), $name, number_format_i18n( $avail_roles[$this_role] ) ); + $role_links[$this_role] = "$name"; } 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() ) { @@ -132,31 +204,68 @@ class WP_Users_List_Table extends WP_List_Table { 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 ( ! current_user_can( 'promote_users' ) ) - return; -?> + ?>
+ - -
-'; } - 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(); } - 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' => '', 'username' => __( 'Username' ), @@ -172,7 +281,15 @@ class WP_Users_List_Table extends WP_List_Table { 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', @@ -185,40 +302,56 @@ class WP_Users_List_Table extends WP_List_Table { 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 ) ); - $style = ''; + $editable_roles = array_keys( get_editable_roles() ); + 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; - $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. * - * @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 + * @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 ) { - global $wp_roles; + public function single_row( $user_object, $style = '', $role = '', $numposts = 0 ) { + $wp_roles = wp_roles(); - if ( !( is_object( $user_object ) && is_a( $user_object, 'WP_User' ) ) ) - $user_object = new WP_User( (int) $user_object ); - $user_object = sanitize_user_object( $user_object, 'display' ); + 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 ) @@ -230,12 +363,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 - // 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(); @@ -251,11 +379,22 @@ class WP_Users_List_Table extends WP_List_Table { $actions['delete'] = "" . __( 'Delete' ) . ""; if ( is_multisite() && get_current_user_id() != $user_object->ID && current_user_can( 'remove_user', $user_object->ID ) ) $actions['remove'] = "" . __( 'Remove' ) . ""; + + /** + * 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 ); - // Set up the checkbox ( because the user is editable, otherwise its empty ) - $checkbox = ""; + // Set up the checkbox ( because the user is editable, otherwise it's empty ) + $checkbox = '' + . ""; } else { $edit = '' . $user_object->user_login . ''; @@ -263,57 +402,87 @@ 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 ); - $r = ""; + $r = ""; - 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\""; - - $style = ''; - if ( in_array( $column_name, $hidden ) ) - $style = ' style="display:none;"'; - - $attributes = "$class$style"; - - switch ( $column_name ) { - case 'cb': - $r .= "$checkbox"; - break; - case 'username': - $r .= "$avatar $edit"; - break; - case 'name': - $r .= "$user_object->first_name $user_object->last_name"; - break; - case 'email': - $r .= "$email"; - break; - case 'role': - $r .= "$role_name"; - break; - case 'posts': - $attributes = 'class="posts column-posts num"' . $style; - $r .= ""; - if ( $numposts > 0 ) { - $r .= ""; - $r .= $numposts; - $r .= ''; - } else { - $r .= 0; - } - $r .= ""; - break; - default: - $r .= ""; - $r .= apply_filters( 'manage_users_custom_column', '', $column_name, $user_object->ID ); - $r .= ""; + $classes = "$column_name column-$column_name"; + if ( $primary === $column_name ) { + $classes .= ' has-row-actions column-primary'; + } + if ( 'posts' === $column_name ) { + $classes .= ' num'; // Special case for that column + } + + if ( in_array( $column_name, $hidden ) ) { + $classes .= ' hidden'; + } + + $data = 'data-colname="' . wp_strip_all_tags( $column_display_name ) . '"'; + + $attributes = "class='$classes' $data"; + + if ( 'cb' === $column_name ) { + $r .= "$checkbox"; + } else { + $r .= ""; + switch ( $column_name ) { + case 'username': + $r .= "$avatar $edit"; + break; + case 'name': + $r .= "$user_object->first_name $user_object->last_name"; + break; + case 'email': + $r .= "$email"; + break; + case 'role': + $r .= $role_name; + break; + case 'posts': + if ( $numposts > 0 ) { + $r .= ""; + $r .= ''; + $r .= '' . sprintf( _n( '%s post by this author', '%s posts by this author', $numposts ), number_format_i18n( $numposts ) ) . ''; + $r .= ''; + } else { + $r .= 0; + } + break; + default: + /** + * 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 ); + } + + if ( $primary === $column_name ) { + $r .= $this->row_actions( $actions ); + } + $r .= ""; } } $r .= ''; return $r; } -} -?> + /** + * Gets the name of the default primary column. + * + * @since 4.3.0 + * @access protected + * + * @return string Name of the default primary column, in this case, 'username'. + */ + protected function get_default_primary_column_name() { + return 'username'; + } +}