WP_List_Table::get_items_per_page( string $option, int $default_value = 20 ): int
Gets the number of items to display on a single page.
Parameters
-
$option
string Required -
User option name.
-
$default_value
int Optional -
The number of items to display.
Default:
20
Return
int
Source
File: wp-admin/includes/class-wp-list-table.php
.
View all references
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 );
}
Hooks
-
apply_filters( "{$option}",
int $per_page ) -
Filters the number of items to be displayed on each page of the list table.
Changelog
Version | Description |
---|---|
3.1.0 | Introduced. |