WP_User_Search::do_paging() │ public │ WP 2.1.0

Handles paging for the user search query.

Method of the class: WP_User_Search{}

No Hooks.

Return

null. Nothing (null).

Usage

$WP_User_Search = new WP_User_Search();
$WP_User_Search->do_paging();

Changelog

WP_User_Search::do_paging() WP User Search::do paging code ^{WP 6.6.2}

public function do_paging() {
	if ( $this->total_users_for_query > $this->users_per_page ) { // Have to page the results.
		$args = array();
		if ( ! empty($this->search_term) )
			$args['usersearch'] = urlencode($this->search_term);
		if ( ! empty($this->role) )
			$args['role'] = urlencode($this->role);

		$this->paging_text = paginate_links( array(
			'total' => ceil($this->total_users_for_query / $this->users_per_page),
			'current' => $this->page,
			'base' => 'users.php?%_%',
			'format' => 'userspage=%#%',
			'add_args' => $args
		) );
		if ( $this->paging_text ) {
			$this->paging_text = sprintf(
				/* translators: 1: Starting number of users on the current page, 2: Ending number of users, 3: Total number of users. */
				'<span class="displaying-num">' . __( 'Displaying %1$s&#8211;%2$s of %3$s' ) . '</span>%s',
				number_format_i18n( ( $this->page - 1 ) * $this->users_per_page + 1 ),
				number_format_i18n( min( $this->page * $this->users_per_page, $this->total_users_for_query ) ),
				number_format_i18n( $this->total_users_for_query ),
				$this->paging_text
			);
		}
	}
}