WP_Users_List_Table::get_views() │ protected │ WP 3.1.0

Returns 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.

Method of the class: WP_Users_List_Table{}

No Hooks.

Return

String[]. An array of HTML links keyed by their view.

Usage

// protected - for code of main (parent) or child class
$result = $this->get_views();

Notes

• Global. String. $role

Changelog

WP_Users_List_Table::get_views() WP Users List Table::get views code ^{WP 6.6.2}

protected function get_views() {
	global $role;

	$wp_roles = wp_roles();

	$count_users = ! wp_is_large_user_count();

	if ( $this->is_site_users ) {
		$url = 'site-users.php?id=' . $this->site_id;
	} else {
		$url = 'users.php';
	}

	$role_links  = array();
	$avail_roles = array();
	$all_text    = __( 'All' );

	if ( $count_users ) {
		if ( $this->is_site_users ) {
			switch_to_blog( $this->site_id );
			$users_of_blog = count_users( 'time', $this->site_id );
			restore_current_blog();
		} else {
			$users_of_blog = count_users();
		}

		$total_users = $users_of_blog['total_users'];
		$avail_roles =& $users_of_blog['avail_roles'];
		unset( $users_of_blog );

		$all_text = sprintf(
			/* translators: %s: Number of users. */
			_nx(
				'All <span class="count">(%s)</span>',
				'All <span class="count">(%s)</span>',
				$total_users,
				'users'
			),
			number_format_i18n( $total_users )
		);
	}

	$role_links['all'] = array(
		'url'     => $url,
		'label'   => $all_text,
		'current' => empty( $role ),
	);

	foreach ( $wp_roles->get_names() as $this_role => $name ) {
		if ( $count_users && ! isset( $avail_roles[ $this_role ] ) ) {
			continue;
		}

		$name = translate_user_role( $name );
		if ( $count_users ) {
			$name = sprintf(
				/* translators: 1: User role name, 2: Number of users. */
				__( '%1$s <span class="count">(%2$s)</span>' ),
				$name,
				number_format_i18n( $avail_roles[ $this_role ] )
			);
		}

		$role_links[ $this_role ] = array(
			'url'     => esc_url( add_query_arg( 'role', $this_role, $url ) ),
			'label'   => $name,
			'current' => $this_role === $role,
		);
	}

	if ( ! empty( $avail_roles['none'] ) ) {

		$name = __( 'No role' );
		$name = sprintf(
			/* translators: 1: User role name, 2: Number of users. */
			__( '%1$s <span class="count">(%2$s)</span>' ),
			$name,
			number_format_i18n( $avail_roles['none'] )
		);

		$role_links['none'] = array(
			'url'     => esc_url( add_query_arg( 'role', 'none', $url ) ),
			'label'   => $name,
			'current' => 'none' === $role,
		);
	}

	return $this->get_views_links( $role_links );
}