W3cubDocs

/WordPress

WP_List_Table::set_pagination_args( array|string $args )

An internal method that sets all the necessary pagination arguments

Parameters

$args

(array|string) (Required) Array or string of arguments with information about the pagination.

Source

File: wp-admin/includes/class-wp-list-table.php 

protected function set_pagination_args( $args ) {
		$args = wp_parse_args(
			$args,
			array(
				'total_items' => 0,
				'total_pages' => 0,
				'per_page'    => 0,
			)
		);

		if ( ! $args['total_pages'] && $args['per_page'] > 0 ) {
			$args['total_pages'] = ceil( $args['total_items'] / $args['per_page'] );
		}

		// Redirect if page number is invalid and headers are not already sent.
		if ( ! headers_sent() && ! wp_doing_ajax() && $args['total_pages'] > 0 && $this->get_pagenum() > $args['total_pages'] ) {
			wp_redirect( add_query_arg( 'paged', $args['total_pages'] ) );
			exit;
		}

		$this->_pagination_args = $args;
	}

Uses

Uses Description
wp-includes/load.php: wp_doing_ajax()

Determines whether the current request is a WordPress Ajax request.
wp-admin/includes/class-wp-list-table.php: WP_List_Table::get_pagenum()

Gets the current page number.
wp-includes/pluggable.php: wp_redirect()

Redirects to another page.
wp-includes/functions.php: wp_parse_args()

Merge user defined arguments into defaults array.
wp-includes/functions.php: add_query_arg()

Retrieves a modified URL query string.

Changelog

Version Description
3.1.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_list_table/set_pagination_args