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–103

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

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 1258 (+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 1261 (+30 into the body)

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

3. 3
   apply_filters( {$option} )filterline 1264 (+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 1270 (+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 ↗

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

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