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

equal deleted inserted replaced

-:346c88efed21
+:5e2f62d02dcd
 <?php
 /**
 * Users List Table class.
 *
+* @since 3.1.0
+* @access private
+*
 * @package WordPress
 * @subpackage List_Table
-* @since 3.1.0
-* @access private
 */
 class WP_Users_List_Table extends WP_List_Table {
-	var $site_id;
+	/**
-	var $is_site_users;
+	 * Site ID to generate the Users list table for.
+	 *
-	function __construct( $args = array() ) {
+	 * @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.
+	 */
+	public function __construct( $args = array() ) {
 		parent::__construct( array(
 			'singular' => 'user',
 			'plural'   => 'users',
 			'screen'   => isset( $args['screen'] ) ? $args['screen'] : null,
 		) );
 		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
+	 */
+	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
+	 */
+	public function prepare_items() {
 		global $role, $usersearch;
-		$usersearch = isset( $_REQUEST['s'] ) ? trim( $_REQUEST['s'] ) : '';
+		$usersearch = isset( $_REQUEST['s'] ) ? wp_unslash( trim( $_REQUEST['s'] ) ) : '';
 		$role = isset( $_REQUEST['role'] ) ? $_REQUEST['role'] : '';
 		$per_page = ( $this->is_site_users ) ? 'site_users_network_per_page' : 'users_per_page';
 		$users_per_page = $this->get_items_per_page( $per_page );
 			'total_items' => $wp_user_search->get_total(),
 			'per_page' => $users_per_page,
 		) );
 	}
-	function no_items() {
+	/**
-		_e( 'No matching users were found.' );
+	 * Output 'no users' message.
-	}
+	 *
+	 * @since 3.1.0
-	function get_views() {
+	 * @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.
+	 *
+	 * @since  3.1.0
+	 * @access protected
+	 *
+	 * @return array An array of HTML links, one for each view.
+	 */
+	protected function get_views() {
 		global $wp_roles, $role;
 		if ( $this->is_site_users ) {
 			$url = 'site-users.php?id=' . $this->site_id;
 			switch_to_blog( $this->site_id );
 		}
 		$total_users = $users_of_blog['total_users'];
 		$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'] = "<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>';
 		foreach ( $wp_roles->get_names() as $this_role => $name ) {
 			if ( !isset($avail_roles[$this_role]) )
 				continue;
 			$class = '';
 			if ( $this_role == $role ) {
-				$current_role = $role;
 				$class = ' class="current"';
 			}
 			$name = translate_user_role( $name );
 			/* translators: User role name with count */
 		}
 		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() ) {
 			if ( current_user_can( 'remove_users' ) )
 				$actions['remove'] = __( 'Remove' );
 		}
 		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;
 	?>
 	<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">
-			<option value=''><?php _e( 'Change role to&hellip;' ) ?></option>
+			<option value=""><?php _e( 'Change role to&hellip;' ) ?></option>
 			<?php wp_dropdown_roles(); ?>
 		</select>
 	<?php
 			submit_button( __( 'Change' ), 'button', 'changeit', false );
 		endif;
+		/**
+		 * Fires just before the closing div containing the bulk role-change controls
+		 * in the Users list table.
+		 *
+		 * @since 3.5.0
+		 */
 		do_action( 'restrict_manage_users' );
 		echo '</div>';
 	}
-	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'       => '<input type="checkbox" />',
 			'username' => __( 'Username' ),
 			'name'     => __( 'Name' ),
 			'email'    => __( 'E-mail' ),
 			unset( $c['posts'] );
 		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',
 			'email'    => 'email',
 		);
 			unset( $c['posts'] );
 		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 ) );
 		$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 );
 			} elseif ( $roles = array_intersect( array_values( $user_object->roles ), $editable_roles ) ) {
 				$role = reset( $roles );
 			}
 			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.
-	 * @param object $user_object
+	 * @access public
-	 * @param string $style Optional. Attributes added to the TR element. Must be sanitized.
+	 *
-	 * @param string $role Key for the $wp_roles array.
+	 * @global WP_Roles $wp_roles User roles object.
-	 * @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.
-	function single_row( $user_object, $style = '', $role = '', $numposts = 0 ) {
+	 * @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.
+	 */
+	public function single_row( $user_object, $style = '', $role = '', $numposts = 0 ) {
 		global $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;
 		if ( $this->is_site_users )
 			$url = "site-users.php?id={$this->site_id}&amp;";
 			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>";
+			/**
+			 * 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 it's empty )
-			$checkbox = '<label class="screen-reader-text" for="cb-select-' . $user_object->ID . '">' . sprintf( __( 'Select %s' ), $user_object->user_login ) . '</label>'
+			$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}' />";
 		} 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 );
-		$r = "<tr id='user-$user_object->ID'$style>";
+		$r = "<tr id='user-$user_object->ID'>";
 		list( $columns, $hidden ) = $this->get_column_info();
 		foreach ( $columns as $column_name => $column_display_name ) {
 			$class = "class=\"$column_name column-$column_name\"";
 					}
 					$r .= "</td>";
 					break;
 				default:
 					$r .= "<td $attributes>";
+					/**
+					 * 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 .= "</td>";
 			}
 		}
 		$r .= '</tr>';

changeset 5	5e2f62d02dcd
parent 0	d970ebf37754
child 7	cf61fcea0001