WP_List_Table::pagination( string $which )

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$whichstring

The location of the pagination: Either 'top' or 'bottom'.

Performance profile

How much work a call to WP_List_Table::pagination() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

126–217

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 242.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

3

3 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()one call below WP_List_Table::pagination()

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 24 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_List_Table::pagination() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 10

• _n()Translates and retrieves the singular or plural form based on the supplied number.
• number_format_i18n()Converts float number to format based on the locale.
• wp_removable_query_args()Returns an array of single-use query variable names that can be removed from a URL.
• set_url_scheme()Sets the scheme for a URL.
• remove_query_arg()Removes an item or items from a query string.
• esc_url()Checks and cleans a URL.
• __()Retrieves the translation of $text.
• add_query_arg()Retrieves a modified URL query string.
• _x()Retrieves translated string with gettext context.
• WP_List_Table::get_pagenum()Gets the current page number.

Used by · 3

• WP_List_Table::display_tablenav()Generates the table navigation above or below the table
• WP_MS_Sites_List_Table::pagination()Displays the pagination.
• WP_MS_Users_List_Table::pagination()

Source code

View on Trac ↗View on GitHub ↗

1018	protected function pagination( $which ) {1019		if ( empty( $this->_pagination_args['total_items'] ) ) {1020			return;1021		}1022 1023		$total_items     = $this->_pagination_args['total_items'];1024		$total_pages     = $this->_pagination_args['total_pages'];1025		$infinite_scroll = false;1026		if ( isset( $this->_pagination_args['infinite_scroll'] ) ) {1027			$infinite_scroll = $this->_pagination_args['infinite_scroll'];1028		}1029 1030		if ( 'top' === $which && $total_pages > 1 ) {1031			$this->screen->render_screen_reader_content( 'heading_pagination' );1032		}1033 1034		$output = '<span class="displaying-num">' . sprintf(1035			/* translators: %s: Number of items. */1036			_n( '%s item', '%s items', $total_items ),1037			number_format_i18n( $total_items )1038		) . '</span>';1039 1040		$current              = $this->get_pagenum();1041		$removable_query_args = wp_removable_query_args();1042 1043		$current_url = set_url_scheme( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );1044 1045		$current_url = remove_query_arg( $removable_query_args, $current_url );1046 1047		$page_links = array();1048 1049		$total_pages_before = '<span class="paging-input">';1050		$total_pages_after  = '</span></span>';1051 1052		$disable_first = false;1053		$disable_last  = false;1054		$disable_prev  = false;1055		$disable_next  = false;1056 1057		if ( 1 === $current ) {1058			$disable_first = true;1059			$disable_prev  = true;1060		}1061		if ( $total_pages === $current ) {1062			$disable_last = true;1063			$disable_next = true;1064		}1065 1066		if ( $disable_first ) {1067			$page_links[] = '<span class="tablenav-pages-navspan button disabled" aria-hidden="true">&laquo;</span>';1068		} else {1069			$page_links[] = sprintf(1070				"<a class='first-page button' href='%s'>" .1071					"<span class='screen-reader-text'>%s</span>" .1072					"<span aria-hidden='true'>%s</span>" .1073				'</a>',1074				esc_url( remove_query_arg( 'paged', $current_url ) ),1075				/* translators: Hidden accessibility text. */1076				__( 'First page' ),1077				'&laquo;'1078			);1079		}1080 1081		if ( $disable_prev ) {1082			$page_links[] = '<span class="tablenav-pages-navspan button disabled" aria-hidden="true">&lsaquo;</span>';1083		} else {1084			$page_links[] = sprintf(1085				"<a class='prev-page button' href='%s'>" .1086					"<span class='screen-reader-text'>%s</span>" .1087					"<span aria-hidden='true'>%s</span>" .1088				'</a>',1089				esc_url( add_query_arg( 'paged', max( 1, $current - 1 ), $current_url ) ),1090				/* translators: Hidden accessibility text. */1091				__( 'Previous page' ),1092				'&lsaquo;'1093			);1094		}1095 1096		if ( 'bottom' === $which ) {1097			$html_current_page  = $current;

Changelog

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