_pad_term_counts( object[]|WP_Term[] $terms, string $taxonomy )
- Since
- 2.3.0
- Source
wp-includes/taxonomy.php:4085
Description
Recalculates term counts by including items from child terms. Assumes all relevant children are already in the $terms argument.
Compatibility
- WordPress
- since 2.3.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
$termsobject[]|WP_Term[]- List of term objects (passed by reference).
$taxonomystring- Term context.
Performance profile
How much work a call to _pad_term_counts() 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
- Scaling
- Scales with input
- Instructions
- 8–61
- Plugin surface
- None
- Called by
- 1
Reaches the database via ->get_results().
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 135.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- sqldatabase query
->get_results()called directly - optionoption read or write
get_option()one call below _pad_term_counts() - querycontent query
get_terms()one call below _pad_term_counts()
Further down the call graph this can also reach hook, 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 · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost _pad_term_counts() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!is_taxonomy_hierarchical() | 8 | is_taxonomy_hierarchical() |
is_taxonomy_hierarchical() && empty($term_hier) | 14 | is_taxonomy_hierarchical(), _get_term_hierarchy() |
is_taxonomy_hierarchical() && !empty($term_hier) | 57–61 | is_taxonomy_hierarchical(), _get_term_hierarchy(), get_taxonomy(), esc_sql(), array_keys(), ->get_results() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 135 | 8–61 | 19 | |
| 8.5 | 135 | 8–61 | 19 | |
| 8.4 | 135 | 8–61 | 19 | 9 fewer instructions than PHP 8.3 |
| 8.3 | 144 | 8–67 | 19 | |
| 8.2 | 144 | 8–67 | 19 | 1 more instruction than PHP 8.1 |
| 8.1 | 143 | 8–76 | 19 | 2 fewer instructions than PHP 7.4 |
| 7.4 | 145 | 8–76 | 19 |
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.
Uses · 4
- is_taxonomy_hierarchical()Determines whether the taxonomy object is hierarchical.
- _get_term_hierarchy()Retrieves children of taxonomy as term IDs.
- get_taxonomy()Retrieves the taxonomy object of $taxonomy.
- esc_sql()Escapes data for use in a MySQL query.
Used by · 1
- WP_Term_Query::get_terms()Retrieves the query results.
Source code
function _pad_term_counts( &$terms, $taxonomy ) { global $wpdb; // This function only works for hierarchical taxonomies like post categories. if ( ! is_taxonomy_hierarchical( $taxonomy ) ) { return; } $term_hier = _get_term_hierarchy( $taxonomy ); if ( empty( $term_hier ) ) { return; } $term_items = array(); $terms_by_id = array(); $term_ids = array(); foreach ( (array) $terms as $key => $term ) { $terms_by_id[ $term->term_id ] = & $terms[ $key ]; $term_ids[ $term->term_taxonomy_id ] = $term->term_id; } // Get the object and term IDs and stick them in a lookup table. $tax_obj = get_taxonomy( $taxonomy ); $object_types = esc_sql( $tax_obj->object_type ); $results = $wpdb->get_results( "SELECT object_id, term_taxonomy_id FROM $wpdb->term_relationships INNER JOIN $wpdb->posts ON object_id = ID WHERE term_taxonomy_id IN (" . implode( ',', array_keys( $term_ids ) ) . ") AND post_type IN ('" . implode( "', '", $object_types ) . "') AND post_status = 'publish'" ); foreach ( $results as $row ) { $id = $term_ids[ $row->term_taxonomy_id ]; $term_items[ $id ][ $row->object_id ] = isset( $term_items[ $id ][ $row->object_id ] ) ? ++$term_items[ $id ][ $row->object_id ] : 1; } // Touch every ancestor's lookup row for each post in each term. foreach ( $term_ids as $term_id ) { $child = $term_id; $ancestors = array(); while ( ! empty( $terms_by_id[ $child ] ) && $parent = $terms_by_id[ $child ]->parent ) { $ancestors[] = $child; if ( ! empty( $term_items[ $term_id ] ) ) { foreach ( $term_items[ $term_id ] as $item_id => $touches ) { $term_items[ $parent ][ $item_id ] = isset( $term_items[ $parent ][ $item_id ] ) ? ++$term_items[ $parent ][ $item_id ] : 1; } } $child = $parent; if ( in_array( $parent, $ancestors, true ) ) { break; } } } // Transfer the touched cells. foreach ( (array) $term_items as $id => $items ) { if ( isset( $terms_by_id[ $id ] ) ) { $terms_by_id[ $id ]->count = count( $items ); } }}Changelog
Introduced in 2.3.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/taxonomy.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.