wppaste
WordPress

block_core_breadcrumbs_get_term_ancestors_items( int $term_id, string $taxonomy ): array

Since
7.0.0
Source
wp-includes/blocks/breadcrumbs.php:330
Generates breadcrumb items for hierarchical term ancestors.

Description

For hierarchical taxonomies, retrieves and formats ancestor terms as breadcrumb links.

Compatibility

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

Present in 2 of the 5 tracked releases, added in 7.0.0, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$term_idint
The term ID.
$taxonomystring
The taxonomy name.

Return value

array
Array of breadcrumb item data for ancestors.

Performance profile

How much work a call to block_core_breadcrumbs_get_term_ancestors_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_term().

Scaling
Scales with input

The body loops, so the work grows with what you pass in.

Instructions
8–21

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
2

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

What it touches

  • querycontent queryget_term()called directly
  • hookthird-party callbacksapply_filters()one call below block_core_breadcrumbs_get_term_ancestors_items()

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

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

WhenInstructionsCalls it makes
!is_taxonomy_hierarchical()8is_taxonomy_hierarchical()
is_taxonomy_hierarchical()20–21is_taxonomy_hierarchical(), get_ancestors(), array_reverse()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 40 instructions, 8–21 executed per call, 5 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.

Uses · 5

Used by · 2

Source code

View on Trac View on GitHub 

function block_core_breadcrumbs_get_term_ancestors_items( $term_id, $taxonomy ) {	$breadcrumb_items = array(); 	// Check if taxonomy is hierarchical and add ancestor term links.	if ( is_taxonomy_hierarchical( $taxonomy ) ) {		$term_ancestors = get_ancestors( $term_id, $taxonomy, 'taxonomy' );		$term_ancestors = array_reverse( $term_ancestors );		foreach ( $term_ancestors as $ancestor_id ) {			$ancestor_term = get_term( $ancestor_id, $taxonomy );			if ( $ancestor_term && ! is_wp_error( $ancestor_term ) ) {				$breadcrumb_items[] = array(					'label' => $ancestor_term->name,					'url'   => get_term_link( $ancestor_term ),				);			}		}	} 	return $breadcrumb_items;}

Changelog

Introduced in 7.0.0. Unchanged from 7.0.4 through 7.1.0.

  1. 7.0.4
  2. 7.1.0

Signature, return type and hooks compared across 2 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/blocks/breadcrumbs.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.