wppaste
WordPress

WP_List_Table::get_items_per_page( string $option, int $default_value = 20 ): int

Since
3.1.0
Source
wp-admin/includes/class-wp-list-table.php:983
Gets the number of items to display on a single page.

Compatibility

WordPress
since 3.1.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$optionstring
User option name.
$default_valueintoptional
The number of items to display. Default 20.Default: 20

Return value

int

Performance profile

How much work a call to WP_List_Table::get_items_per_page() 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
16–18

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

Plugin surface
1 hook

Third-party callbacks on '{$option}' run inside this call, and their cost is not bounded by anything here.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

  • hookthird-party callbacksapply_filters()called directly

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 · 1 distinct outcome

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

WhenInstructionsCalls it makes
always16–18get_user_option(), apply_filters()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 18 instructions, 16–18 executed per call, 2 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Hooks and filters fired · 1

One hook fires while WP_List_Table::get_items_per_page() runs, in this order:

  1. apply_filters( {$option} )filterline 1013 (+30 into the body)

    Filters the number of items to be displayed on each page of the list table.

Uses · 2

  • get_user_option()Retrieves user option that can be either per Site or per Network.
  • apply_filters()Calls the callback functions that have been added to a filter hook.

Source code

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

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