WP_Users_List_Table

Hooks fired · 6

Every hook that fires from inside WP_Users_List_Table, in the order it appears in the class, grouped by the method that fires it.

Properties · 2

$site_idintpublic

Site ID to generate the Users list table for.

$is_site_usersboolpublic

Whether or not the current Users list table is for Multisite.

Methods · 14

• __construct()Constructor.
• ajax_user_can()Checks the current user's permissions.
• prepare_items()Prepares the users list for display.
• no_items()Outputs 'no users' message.
• get_views()Returns an associative array listing all the views that can be used with this table.
• get_bulk_actions()Retrieves an associative array of bulk actions available on this table.
• extra_tablenav()Outputs the controls to allow user roles to be changed in bulk.
• current_action()Captures the bulk action required, and return it.
• get_columns()Gets a list of columns for the list table.
• get_sortable_columns()Gets a list of sortable columns for the list table.
• display_rows()Generates the list table rows.
• single_row()Generates HTML for a single row on the users.php admin panel.
• get_default_primary_column_name()Gets the name of the default primary column.
• get_role_list()Returns an array of translated user role names for a given user object.

Source

View on Trac ↗View on GitHub ↗

17class WP_Users_List_Table extends WP_List_Table {18 19	/**20	 * Site ID to generate the Users list table for.21	 *22	 * @since 3.1.023	 * @var int24	 */25	public $site_id;26 27	/**28	 * Whether or not the current Users list table is for Multisite.29	 *30	 * @since 3.1.031	 * @var bool32	 */33	public $is_site_users;34 35	/**36	 * Constructor.37	 *38	 * @since 3.1.039	 *40	 * @see WP_List_Table::__construct() for more information on default arguments.41	 *42	 * @param array $args An associative array of arguments.43	 */44	public function __construct( $args = array() ) {45		parent::__construct(46			array(47				'singular' => 'user',48				'plural'   => 'users',49				'screen'   => $args['screen'] ?? null,50			)51		);52 53		$this->is_site_users = 'site-users-network' === $this->screen->id;54 55		if ( $this->is_site_users ) {56			$this->site_id = isset( $_REQUEST['id'] ) ? (int) $_REQUEST['id'] : 0;57		}58	}59 60	/**61	 * Checks the current user's permissions.62	 *63	 * @since 3.1.064	 *65	 * @return bool66	 */67	public function ajax_user_can() {68		if ( $this->is_site_users ) {69			return current_user_can( 'manage_sites' );70		} else {71			return current_user_can( 'list_users' );72		}73	}74 75	/**76	 * Prepares the users list for display.77	 *78	 * @since 3.1.079	 *80	 * @global string $role81	 * @global string $usersearch82	 */83	public function prepare_items() {84		global $role, $usersearch;85 86		$usersearch = isset( $_REQUEST['s'] ) ? wp_unslash( trim( $_REQUEST['s'] ) ) : '';87 88		$role = $_REQUEST['role'] ?? '';89 90		$per_page       = ( $this->is_site_users ) ? 'site_users_network_per_page' : 'users_per_page';91		$users_per_page = $this->get_items_per_page( $per_page );92 93		$paged = $this->get_pagenum();94 95		if ( 'none' === $role ) {96			$args = array(

History

Introduced in 3.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-admin/includes/class-wp-users-list-table.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.