WP_Terms_List_Table::prepare_items()

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_Terms_List_Table::prepare_items() 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

Heavy

Reaches the database via get_terms().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

60–103

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

Plugin surface

3 hooks

Third-party callbacks on 'edit_tags_per_page', 'tagsperpage', 'edit_categories_per_page' 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
• querycontent queryget_terms()called directly

Further down the call graph this can also reach 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 · 12 distinct outcomes

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

Hooks and filters fired · 3

3 hooks fire while WP_Terms_List_Table::prepare_items() runs, in this order:

1. 1
   apply_filters( edit_tags_per_page )filterline 90 (+13 into the body)

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

2. 2
   do_action( tagsperpage )filter_deprecatedline 100 (+23 into the body)

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

3. 3
   apply_filters( edit_categories_per_page )filterline 109 (+32 into the body)

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

Uses · 9

• apply_filters()Calls the callback functions that have been added to a filter hook.
• apply_filters_deprecated()Fires functions attached to a deprecated filter hook.
• wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
• is_taxonomy_hierarchical()Determines whether the taxonomy object is hierarchical.
• get_terms()Retrieves the terms in a given taxonomy or list of taxonomies.
• wp_count_terms()Counts how many terms are in taxonomy.
• WP_Terms_List_Table::get_items_per_page()
• WP_Terms_List_Table::get_pagenum()
• WP_Terms_List_Table::set_pagination_args()

Source code

View on Trac ↗View on GitHub ↗

77	public function prepare_items() {78		$taxonomy = $this->screen->taxonomy;79 80		$tags_per_page = $this->get_items_per_page( "edit_{$taxonomy}_per_page" );81 82		if ( 'post_tag' === $taxonomy ) {83			/**84			 * Filters the number of terms displayed per page for the Tags list table.85			 *86			 * @since 2.8.087			 *88			 * @param int $tags_per_page Number of tags to be displayed. Default 20.89			 */90			$tags_per_page = apply_filters( 'edit_tags_per_page', $tags_per_page );91 92			/**93			 * Filters the number of terms displayed per page for the Tags list table.94			 *95			 * @since 2.7.096			 * @deprecated 2.8.0 Use {@see 'edit_tags_per_page'} instead.97			 *98			 * @param int $tags_per_page Number of tags to be displayed. Default 20.99			 */100			$tags_per_page = apply_filters_deprecated( 'tagsperpage', array( $tags_per_page ), '2.8.0', 'edit_tags_per_page' );101		} elseif ( 'category' === $taxonomy ) {102			/**103			 * Filters the number of terms displayed per page for the Categories list table.104			 *105			 * @since 2.8.0106			 *107			 * @param int $tags_per_page Number of categories to be displayed. Default 20.108			 */109			$tags_per_page = apply_filters( 'edit_categories_per_page', $tags_per_page );110		}111 112		$search = ! empty( $_REQUEST['s'] ) ? trim( wp_unslash( $_REQUEST['s'] ) ) : '';113 114		$args = array(115			'taxonomy'   => $taxonomy,116			'search'     => $search,117			'page'       => $this->get_pagenum(),118			'number'     => $tags_per_page,119			'hide_empty' => 0,120		);121 122		if ( ! empty( $_REQUEST['orderby'] ) ) {123			$args['orderby'] = trim( wp_unslash( $_REQUEST['orderby'] ) );124		}125 126		if ( ! empty( $_REQUEST['order'] ) ) {127			$args['order'] = trim( wp_unslash( $_REQUEST['order'] ) );128		}129 130		$args['offset'] = ( $args['page'] - 1 ) * $args['number'];131 132		// Save the values because 'number' and 'offset' can be subsequently overridden.133		$this->callback_args = $args;134 135		if ( is_taxonomy_hierarchical( $taxonomy ) && ! isset( $args['orderby'] ) ) {136			// We'll need the full set of terms then.137			$args['number'] = 0;138			$args['offset'] = $args['number'];139		}140 141		$this->items = get_terms( $args );142 143		$this->set_pagination_args(144			array(145				'total_items' => wp_count_terms(146					array(147						'taxonomy' => $taxonomy,148						'search'   => $search,149					)150				),151				'per_page'    => $tags_per_page,152			)153		);154	}

Changelog

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