wp-admin/includes/class-wp-ms-users-list-table.php

   1 <?php
   2 /**
   3  * Multisite Users List Table class.
   4  *
   5  * @package WordPress
   6  * @subpackage List_Table
   7  * @since 3.1.0
   8  * @access private
   9  */
  10 class WP_MS_Users_List_Table extends WP_List_Table {
  11         /**
  12          *
  13          * @return bool
  14          */
  15         public function ajax_user_can() {
  16                 return current_user_can( 'manage_network_users' );
  17         }
  18
  19         /**
  20          *
  21          * @global string $usersearch
  22          * @global string $role
  23          * @global wpdb   $wpdb
  24          * @global string $mode
  25          */
  26         public function prepare_items() {
  27                 global $usersearch, $role, $wpdb, $mode;
  28
  29                 $usersearch = isset( $_REQUEST['s'] ) ? wp_unslash( trim( $_REQUEST['s'] ) ) : '';
  30
  31                 $users_per_page = $this->get_items_per_page( 'users_network_per_page' );
  32
  33                 $role = isset( $_REQUEST['role'] ) ? $_REQUEST['role'] : '';
  34
  35                 $paged = $this->get_pagenum();
  36
  37                 $args = array(
  38                         'number' => $users_per_page,
  39                         'offset' => ( $paged-1 ) * $users_per_page,
  40                         'search' => $usersearch,
  41                         'blog_id' => 0,
  42                         'fields' => 'all_with_meta'
  43                 );
  44
  45                 if ( wp_is_large_network( 'users' ) )
  46                         $args['search'] = ltrim( $args['search'], '*' );
  47
  48                 if ( $role == 'super' ) {
  49                         $logins = implode( "', '", get_super_admins() );
  50                         $args['include'] = $wpdb->get_col( "SELECT ID FROM $wpdb->users WHERE user_login IN ('$logins')" );
  51                 }
  52
  53                 /*
  54                  * If the network is large and a search is not being performed,
  55                  * show only the latest users with no paging in order to avoid
  56                  * expensive count queries.
  57                  */
  58                 if ( !$usersearch && wp_is_large_network( 'users' ) ) {
  59                         if ( !isset($_REQUEST['orderby']) )
  60                                 $_GET['orderby'] = $_REQUEST['orderby'] = 'id';
  61                         if ( !isset($_REQUEST['order']) )
  62                                 $_GET['order'] = $_REQUEST['order'] = 'DESC';
  63                         $args['count_total'] = false;
  64                 }
  65
  66                 if ( isset( $_REQUEST['orderby'] ) )
  67                         $args['orderby'] = $_REQUEST['orderby'];
  68
  69                 if ( isset( $_REQUEST['order'] ) )
  70                         $args['order'] = $_REQUEST['order'];
  71
  72                 $mode = empty( $_REQUEST['mode'] ) ? 'list' : $_REQUEST['mode'];
  73
  74                 // Query the user IDs for this page
  75                 $wp_user_search = new WP_User_Query( $args );
  76
  77                 $this->items = $wp_user_search->get_results();
  78
  79                 $this->set_pagination_args( array(
  80                         'total_items' => $wp_user_search->get_total(),
  81                         'per_page' => $users_per_page,
  82                 ) );
  83         }
  84
  85         /**
  86          *
  87          * @return array
  88          */
  89         protected function get_bulk_actions() {
  90                 $actions = array();
  91                 if ( current_user_can( 'delete_users' ) )
  92                         $actions['delete'] = __( 'Delete' );
  93                 $actions['spam'] = _x( 'Mark as Spam', 'user' );
  94                 $actions['notspam'] = _x( 'Not Spam', 'user' );
  95
  96                 return $actions;
  97         }
  98
  99         /**
 100          * @access public
 101          */
 102         public function no_items() {
 103                 _e( 'No users found.' );
 104         }
 105
 106         /**
 107          *
 108          * @global string $role
 109          * @return array
 110          */
 111         protected function get_views() {
 112                 global $role;
 113
 114                 $total_users = get_user_count();
 115                 $super_admins = get_super_admins();
 116                 $total_admins = count( $super_admins );
 117
 118                 $class = $role != 'super' ? ' class="current"' : '';
 119                 $role_links = array();
 120                 $role_links['all'] = "<a href='" . network_admin_url('users.php') . "'$class>" . sprintf( _nx( 'All <span class="count">(%s)</span>', 'All <span class="count">(%s)</span>', $total_users, 'users' ), number_format_i18n( $total_users ) ) . '</a>';
 121                 $class = $role == 'super' ? ' class="current"' : '';
 122                 $role_links['super'] = "<a href='" . network_admin_url('users.php?role=super') . "'$class>" . sprintf( _n( 'Super Admin <span class="count">(%s)</span>', 'Super Admins <span class="count">(%s)</span>', $total_admins ), number_format_i18n( $total_admins ) ) . '</a>';
 123
 124                 return $role_links;
 125         }
 126
 127         /**
 128          * @global string $mode
 129          * @param string $which
 130          */
 131         protected function pagination( $which ) {
 132                 global $mode;
 133
 134                 parent::pagination ( $which );
 135
 136                 if ( 'top' == $which )
 137                         $this->view_switcher( $mode );
 138         }
 139
 140         /**
 141          *
 142          * @return array
 143          */
 144         public function get_columns() {
 145                 $users_columns = array(
 146                         'cb'         => '<input type="checkbox" />',
 147                         'username'   => __( 'Username' ),
 148                         'name'       => __( 'Name' ),
 149                         'email'      => __( 'E-mail' ),
 150                         'registered' => _x( 'Registered', 'user' ),
 151                         'blogs'      => __( 'Sites' )
 152                 );
 153                 /**
 154                  * Filter the columns displayed in the Network Admin Users list table.
 155                  *
 156                  * @since MU
 157                  *
 158                  * @param array $users_columns An array of user columns. Default 'cb', 'username',
 159                  *                             'name', 'email', 'registered', 'blogs'.
 160                  */
 161                 return apply_filters( 'wpmu_users_columns', $users_columns );
 162         }
 163
 164         /**
 165          *
 166          * @return array
 167          */
 168         protected function get_sortable_columns() {
 169                 return array(
 170                         'username'   => 'login',
 171                         'name'       => 'name',
 172                         'email'      => 'email',
 173                         'registered' => 'id',
 174                 );
 175         }
 176
 177         /**
 178          * Handles the checkbox column output.
 179          *
 180          * @since 4.3.0
 181          * @access public
 182          *
 183          * @param WP_User $user The current WP_User object.
 184          */
 185         public function column_cb( $user ) {
 186                 ?>
 187                 <label class="screen-reader-text" for="blog_<?php echo $user->ID; ?>"><?php echo sprintf( __( 'Select %s' ), $user->user_login ); ?></label>
 188                 <input type="checkbox" id="blog_<?php echo $user->ID ?>" name="allusers[]" value="<?php echo esc_attr( $user->ID ) ?>" />
 189                 <?php
 190         }
 191
 192         /**
 193          * Handles the username column output.
 194          *
 195          * @since 4.3.0
 196          * @access public
 197          *
 198          * @param WP_User $user The current WP_User object.
 199          */
 200         public function column_username( $user ) {
 201                 $super_admins = get_super_admins();
 202                 $avatar = get_avatar( $user->user_email, 32 );
 203                 $edit_link = esc_url( add_query_arg( 'wp_http_referer', urlencode( wp_unslash( $_SERVER['REQUEST_URI'] ) ), get_edit_user_link( $user->ID ) ) );
 204
 205                 echo $avatar;
 206
 207                 ?><strong><a href="<?php echo $edit_link; ?>" class="edit"><?php echo $user->user_login; ?></a><?php
 208                 if ( in_array( $user->user_login, $super_admins ) ) {
 209                         echo ' - ' . __( 'Super Admin' );
 210                 }
 211                 ?></strong>
 212         <?php
 213         }
 214
 215         /**
 216          * Handles the name column output.
 217          *
 218          * @since 4.3.0
 219          * @access public
 220          *
 221          * @param WP_User $user The current WP_User object.
 222          */
 223         public function column_name( $user ) {
 224                 echo "$user->first_name $user->last_name";
 225         }
 226
 227         /**
 228          * Handles the email column output.
 229          *
 230          * @since 4.3.0
 231          * @access public
 232          *
 233          * @param WP_User $user The current WP_User object.
 234          */
 235         public function column_email( $user ) {
 236                 echo "<a href='mailto:$user->user_email'>$user->user_email</a>";
 237         }
 238
 239         /**
 240          * Handles the registered date column output.
 241          *
 242          * @since 4.3.0
 243          * @access public
 244          *
 245          * @global string $mode
 246          *
 247          * @param WP_User $user The current WP_User object.
 248          */
 249         public function column_registered( $user ) {
 250                 global $mode;
 251                 if ( 'list' == $mode ) {
 252                         $date = __( 'Y/m/d' );
 253                 } else {
 254                         $date = __( 'Y/m/d g:i:s a' );
 255                 }
 256                 echo mysql2date( $date, $user->user_registered );
 257         }
 258
 259         /**
 260          * @since 4.3.0
 261          * @access protected
 262          *
 263          * @param WP_User $user
 264          * @param string  $classes
 265          * @param string  $data
 266          * @param string  $primary
 267          */
 268         protected function _column_blogs( $user, $classes, $data, $primary ) {
 269                 echo '<td class="', $classes, ' has-row-actions" ', $data, '>';
 270                 echo $this->column_blogs( $user );
 271                 echo $this->handle_row_actions( $user, 'blogs', $primary );
 272                 echo '</td>';
 273         }
 274
 275         /**
 276          * Handles the blogs/sites column output.
 277          *
 278          * @since 4.3.0
 279          * @access public
 280          *
 281          * @param WP_User $user The current WP_User object.
 282          */
 283         public function column_blogs( $user ) {
 284                 $blogs = get_blogs_of_user( $user->ID, true );
 285                 if ( ! is_array( $blogs ) ) {
 286                         return;
 287                 }
 288
 289                 foreach ( $blogs as $val ) {
 290                         if ( ! can_edit_network( $val->site_id ) ) {
 291                                 continue;
 292                         }
 293
 294                         $path   = ( $val->path == '/' ) ? '' : $val->path;
 295                         echo '<span class="site-' . $val->site_id . '" >';
 296                         echo '<a href="'. esc_url( network_admin_url( 'site-info.php?id=' . $val->userblog_id ) ) .'">' . str_replace( '.' . get_current_site()->domain, '', $val->domain . $path ) . '</a>';
 297                         echo ' <small class="row-actions">';
 298                         $actions = array();
 299                         $actions['edit'] = '<a href="'. esc_url( network_admin_url( 'site-info.php?id=' . $val->userblog_id ) ) .'">' . __( 'Edit' ) . '</a>';
 300
 301                         $class = '';
 302                         if ( $val->spam == 1 ) {
 303                                 $class .= 'site-spammed ';
 304                         }
 305                         if ( $val->mature == 1 ) {
 306                                 $class .= 'site-mature ';
 307                         }
 308                         if ( $val->deleted == 1 ) {
 309                                 $class .= 'site-deleted ';
 310                         }
 311                         if ( $val->archived == 1 ) {
 312                                 $class .= 'site-archived ';
 313                         }
 314
 315                         $actions['view'] = '<a class="' . $class . '" href="' . esc_url( get_home_url( $val->userblog_id ) ) . '">' . __( 'View' ) . '</a>';
 316
 317                         /**
 318                          * Filter the action links displayed next the sites a user belongs to
 319                          * in the Network Admin Users list table.
 320                          *
 321                          * @since 3.1.0
 322                          *
 323                          * @param array $actions     An array of action links to be displayed.
 324                          *                           Default 'Edit', 'View'.
 325                          * @param int   $userblog_id The site ID.
 326                          */
 327                         $actions = apply_filters( 'ms_user_list_site_actions', $actions, $val->userblog_id );
 328
 329                         $i=0;
 330                         $action_count = count( $actions );
 331                         foreach ( $actions as $action => $link ) {
 332                                 ++$i;
 333                                 $sep = ( $i == $action_count ) ? '' : ' | ';
 334                                 echo "<span class='$action'>$link$sep</span>";
 335                         }
 336                         echo '</small></span><br/>';
 337                 }
 338         }
 339
 340         /**
 341          * Handles the default column output.
 342          *
 343          * @since 4.3.0
 344          * @access public
 345          *
 346          * @param WP_User $user       The current WP_User object.
 347          * @param string $column_name The current column name.
 348          */
 349         public function column_default( $user, $column_name ) {
 350                 /** This filter is documented in wp-admin/includes/class-wp-users-list-table.php */
 351                 echo apply_filters( 'manage_users_custom_column', '', $column_name, $user->ID );
 352         }
 353
 354         public function display_rows() {
 355                 foreach ( $this->items as $user ) {
 356                         $class = '';
 357
 358                         $status_list = array( 'spam' => 'site-spammed', 'deleted' => 'site-deleted' );
 359
 360                         foreach ( $status_list as $status => $col ) {
 361                                 if ( $user->$status ) {
 362                                         $class .= " $col";
 363                                 }
 364                         }
 365
 366                         ?>
 367                         <tr class="<?php echo trim( $class ); ?>">
 368                                 <?php $this->single_row_columns( $user ); ?>
 369                         </tr>
 370                         <?php
 371                 }
 372         }
 373
 374         /**
 375          * Gets the name of the default primary column.
 376          *
 377          * @since 4.3.0
 378          * @access protected
 379          *
 380          * @return string Name of the default primary column, in this case, 'username'.
 381          */
 382         protected function get_default_primary_column_name() {
 383                 return 'username';
 384         }
 385
 386         /**
 387          * Generates and displays row action links.
 388          *
 389          * @since 4.3.0
 390          * @access protected
 391          *
 392          * @param object $user        User being acted upon.
 393          * @param string $column_name Current column name.
 394          * @param string $primary     Primary column name.
 395          * @return string Row actions output for users in Multisite.
 396          */
 397         protected function handle_row_actions( $user, $column_name, $primary ) {
 398                 if ( $primary !== $column_name ) {
 399                         return '';
 400                 }
 401
 402                 $super_admins = get_super_admins();
 403                 $edit_link = esc_url( add_query_arg( 'wp_http_referer', urlencode( wp_unslash( $_SERVER['REQUEST_URI'] ) ), get_edit_user_link( $user->ID ) ) );
 404
 405                 $actions = array();
 406                 $actions['edit'] = '<a href="' . $edit_link . '">' . __( 'Edit' ) . '</a>';
 407
 408                 if ( current_user_can( 'delete_user', $user->ID ) && ! in_array( $user->user_login, $super_admins ) ) {
 409                         $actions['delete'] = '<a href="' . $delete = esc_url( network_admin_url( add_query_arg( '_wp_http_referer', urlencode( wp_unslash( $_SERVER['REQUEST_URI'] ) ), wp_nonce_url( 'users.php', 'deleteuser' ) . '&amp;action=deleteuser&amp;id=' . $user->ID ) ) ) . '" class="delete">' . __( 'Delete' ) . '</a>';
 410                 }
 411
 412                 /**
 413                  * Filter the action links displayed under each user in the Network Admin Users list table.
 414                  *
 415                  * @since 3.2.0
 416                  *
 417                  * @param array   $actions An array of action links to be displayed.
 418                  *                         Default 'Edit', 'Delete'.
 419                  * @param WP_User $user    WP_User object.
 420                  */
 421                 $actions = apply_filters( 'ms_user_row_actions', $actions, $user );
 422                 return $this->row_actions( $actions );
 423         }
 424 }