WP_Screen::render_per_page_options()

Compatibility

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

Performance profile

How much work a call to WP_Screen::render_per_page_options() 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

6–101

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

Plugin surface

4 hooks

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

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

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 · 17 distinct outcomes

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

Hooks and filters fired · 4

4 hooks fire while WP_Screen::render_per_page_options() runs, in this order:

1. 1
   apply_filters( comments_per_page )filterline 1260 (+27 into the body)

   Filters the number of comments listed per page in the comments list table.

2. 2
   apply_filters( edit_categories_per_page )filterline 1263 (+30 into the body)

   Filters the number of terms displayed per page for the Categories list table.

3. 3
   apply_filters( {$option} )filterline 1266 (+33 into the body)

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

4. 4
   apply_filters( edit_posts_per_page )filterline 1272 (+39 into the body)

   Filters the number of posts displayed per page when specifically listing "posts".

Uses · 7

• __()Retrieves the translation of $text.
• 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.
• add_filter()Adds a callback function to a filter hook.
• _e()Displays translated text.
• esc_attr()Escaping for HTML attributes.
• WP_Screen::get_option()Gets the arguments for an option for the screen.

Used by · 1

• WP_Screen::render_screen_options()Renders the screen options tab.

Source code

View on Trac ↗View on GitHub ↗

1233	public function render_per_page_options() {1234		if ( null === $this->get_option( 'per_page' ) ) {1235			return;1236		}1237 1238		$per_page_label = $this->get_option( 'per_page', 'label' );1239		if ( null === $per_page_label ) {1240			$per_page_label = __( 'Number of items per page:' );1241		}1242 1243		$option = $this->get_option( 'per_page', 'option' );1244		if ( ! $option ) {1245			$option = str_replace( '-', '_', "{$this->id}_per_page" );1246		}1247 1248		$per_page = (int) get_user_option( $option );1249		if ( empty( $per_page ) || $per_page < 1 ) {1250			$per_page = $this->get_option( 'per_page', 'default' );1251			if ( ! $per_page ) {1252				$per_page = 20;1253			}1254		}1255 1256		if ( 'edit_comments_per_page' === $option ) {1257			$comment_status = $_REQUEST['comment_status'] ?? 'all';1258 1259			/** This filter is documented in wp-admin/includes/class-wp-comments-list-table.php */1260			$per_page = apply_filters( 'comments_per_page', $per_page, $comment_status );1261		} elseif ( 'categories_per_page' === $option ) {1262			/** This filter is documented in wp-admin/includes/class-wp-terms-list-table.php */1263			$per_page = apply_filters( 'edit_categories_per_page', $per_page );1264		} else {1265			/** This filter is documented in wp-admin/includes/class-wp-list-table.php */1266			$per_page = apply_filters( "{$option}", $per_page );1267		}1268 1269		// Back compat.1270		if ( isset( $this->post_type ) ) {1271			/** This filter is documented in wp-admin/includes/post.php */1272			$per_page = apply_filters( 'edit_posts_per_page', $per_page, $this->post_type );1273		}1274 1275		// This needs a submit button.1276		add_filter( 'screen_options_show_submit', '__return_true' );1277 1278		?>1279		<fieldset class="screen-options">1280		<legend><?php _e( 'Pagination' ); ?></legend>1281			<?php if ( $per_page_label ) : ?>1282				<label for="<?php echo esc_attr( $option ); ?>"><?php echo $per_page_label; ?></label>1283				<input type="number" step="1" min="1" max="999" class="screen-per-page small-text" name="wp_screen_options[value]"1284					id="<?php echo esc_attr( $option ); ?>"1285					value="<?php echo esc_attr( $per_page ); ?>" />1286			<?php endif; ?>1287				<input type="hidden" name="wp_screen_options[option]" value="<?php echo esc_attr( $option ); ?>" />1288		</fieldset>1289		<?php1290	}

Changelog

Introduced in 3.3.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 7.0.4 tag, from src/wp-admin/includes/class-wp-screen.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.