WordPress at Your Fingertips
function is not described

WP_List_Table::set_pagination_args() protected WP 3.1.0

An internal method that sets all the necessary pagination arguments

{} It's a method of the class: WP_List_Table{}

No Hooks.

Return

null. Nothing.

Usage

// protected - for code of main (parent) or child class
$result = $this->set_pagination_args( $args );
$args(array|string) (required)
Array or string of arguments with information about the pagination.

Changelog

Since 3.1.0 Introduced.

Code of WP_List_Table::set_pagination_args() WP 5.8.1

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;
}