X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/41578db67d72562346e4dbb2a14889b23d522813..refs/tags/wordpress-4.3.1:/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 dcce6d55..bb83f856 100644 --- a/wp-admin/includes/class-wp-users-list-table.php +++ b/wp-admin/includes/class-wp-users-list-table.php @@ -17,7 +17,7 @@ class WP_Users_List_Table extends WP_List_Table { * @access public * @var int */ - var $site_id; + public $site_id; /** * Whether or not the current Users list table is for Multisite. @@ -26,15 +26,19 @@ class WP_Users_List_Table extends WP_List_Table { * @access public * @var bool */ - var $is_site_users; + 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. */ - function __construct( $args = array() ) { + public function __construct( $args = array() ) { parent::__construct( array( 'singular' => 'user', 'plural' => 'users', @@ -52,8 +56,10 @@ class WP_Users_List_Table extends WP_List_Table { * * @since 3.1.0 * @access public + * + * @return bool */ - function ajax_user_can() { + public function ajax_user_can() { if ( $this->is_site_users ) return current_user_can( 'manage_sites' ); else @@ -65,8 +71,11 @@ class WP_Users_List_Table extends WP_List_Table { * * @since 3.1.0 * @access public + * + * @global string $role + * @global string $usersearch */ - function prepare_items() { + public function prepare_items() { global $role, $usersearch; $usersearch = isset( $_REQUEST['s'] ) ? wp_unslash( trim( $_REQUEST['s'] ) ) : ''; @@ -115,8 +124,8 @@ class WP_Users_List_Table extends WP_List_Table { * @since 3.1.0 * @access public */ - function no_items() { - _e( 'No matching users were found.' ); + public function no_items() { + _e( 'No users found.' ); } /** @@ -127,12 +136,16 @@ class WP_Users_List_Table extends WP_List_Table { * filtering of the user table. * * @since 3.1.0 - * @access public + * @access protected + * + * @global string $role * * @return array An array of HTML links, one for each view. */ - function get_views() { - global $wp_roles, $role; + protected function get_views() { + global $role; + + $wp_roles = wp_roles(); if ( $this->is_site_users ) { $url = 'site-users.php?id=' . $this->site_id; @@ -147,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 ) ) . ''; @@ -158,7 +170,6 @@ class WP_Users_List_Table extends WP_List_Table { $class = ''; if ( $this_role == $role ) { - $current_role = $role; $class = ' class="current"'; } @@ -175,11 +186,11 @@ class WP_Users_List_Table extends WP_List_Table { * Retrieve an associative array of bulk actions available on this table. * * @since 3.1.0 - * @access public + * @access protected * * @return array Array of bulk actions. */ - function get_bulk_actions() { + protected function get_bulk_actions() { $actions = array(); if ( is_multisite() ) { @@ -197,12 +208,12 @@ class WP_Users_List_Table extends WP_List_Table { * Output the controls to allow user roles to be changed in bulk. * * @since 3.1.0 - * @access public + * @access protected * * @param string $which Whether this is being invoked above ("top") * or below the table ("bottom"). */ - function extra_tablenav( $which ) { + protected function extra_tablenav( $which ) { if ( 'top' != $which ) return; ?> @@ -210,7 +221,7 @@ class WP_Users_List_Table extends WP_List_Table { '', 'username' => __( 'Username' ), @@ -274,11 +285,11 @@ class WP_Users_List_Table extends WP_List_Table { * Get a list of sortable columns for the list table. * * @since 3.1.0 - * @access public + * @access protected * * @return array Array of sortable columns. */ - function get_sortable_columns() { + protected function get_sortable_columns() { $c = array( 'username' => 'login', 'name' => 'name', @@ -297,14 +308,13 @@ class WP_Users_List_Table extends WP_List_Table { * @since 3.1.0 * @access public */ - function display_rows() { + 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() ); - $style = ''; foreach ( $this->items as $userid => $user_object ) { if ( count( $user_object->roles ) <= 1 ) { $role = reset( $user_object->roles ); @@ -317,8 +327,7 @@ class WP_Users_List_Table extends WP_List_Table { 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 ); } } @@ -326,21 +335,22 @@ 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 + * @since 4.2.0 The `$style` argument was deprecated. * @access public * * @param object $user_object The current user object. - * @param string $style Optional. Style attributes added to the element. - * Must be sanitized. Default empty. + * @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' ) ) ) + if ( ! ( $user_object instanceof WP_User ) ) { $user_object = get_userdata( (int) $user_object ); + } $user_object->filter = 'display'; $email = $user_object->user_email; @@ -381,10 +391,9 @@ class WP_Users_List_Table extends WP_List_Table { * @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 it's empty ) - $checkbox = '' + $checkbox = '' . ""; } else { @@ -393,65 +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 .= ""; - - /** - * 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 .= ""; + $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'; + } }