WP_List_Table::get_items_per_page │ protected │ WP 3.1.0

Gets the number of items to display on a single page.

Method of the class: WP_List_Table{}

Returns

Int. Number of items to display per page.

Usage

// protected - for code of main (parent) or child class
$result = $this->get_items_per_page( $option, $default_value );

$option(string) (required)

User option name.

$default_value(int)

The number of items to display.
Default: 20

Changelog

WP_List_Table::get_items_per_page() WP List Table::get items per page code ^{WP 7.0}

protected function get_items_per_page( $option, $default_value = 20 ) {
	$per_page = (int) get_user_option( $option );
	if ( empty( $per_page ) || $per_page < 1 ) {
		$per_page = $default_value;
	}

	/**
	 * Filters the number of items to be displayed on each page of the list table.
	 *
	 * The dynamic hook name, `$option`, refers to the `per_page` option depending
	 * on the type of list table in use. Possible filter names include:
	 *
	 *  - `edit_comments_per_page`
	 *  - `sites_network_per_page`
	 *  - `site_themes_network_per_page`
	 *  - `themes_network_per_page`
	 *  - `users_network_per_page`
	 *  - `edit_post_per_page`
	 *  - `edit_page_per_page`
	 *  - `edit_{$post_type}_per_page`
	 *  - `edit_post_tag_per_page`
	 *  - `edit_category_per_page`
	 *  - `edit_{$taxonomy}_per_page`
	 *  - `site_users_network_per_page`
	 *  - `users_per_page`
	 *
	 * @since 2.9.0
	 *
	 * @param int $per_page Number of items to be displayed. Default 20.
	 */
	return (int) apply_filters( "{$option}", $per_page );
}