block_core_breadcrumbs_get_terms_breadcrumbs( int $post_id, string $post_type ): array

Description

Compatibility

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

Parameters

$post_idint

The post ID.

$post_typestring

The post type name.

Return value

array

Array of breadcrumb item data.

Performance profile

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

Scaling

Scales with input

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

Instructions

15–107

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

Plugin surface

1 hook

Third-party callbacks on 'block_core_breadcrumbs_post_type_settings' 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
• querycontent queryget_post()one call below block_core_breadcrumbs_get_terms_breadcrumbs()
• cacheobject cachewp_cache_add()one call below block_core_breadcrumbs_get_terms_breadcrumbs()

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

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

Hooks and filters fired · 1

One hook fires while block_core_breadcrumbs_get_terms_breadcrumbs() runs, in this order:

1. 1
   apply_filters( block_core_breadcrumbs_post_type_settings )filterline 540 (+40 into the body)

   Filters breadcrumb settings (taxonomy and term selection) for a post or post type.

Uses · 7

• wp_filter_object_list()Filters a list of objects, based on a set of key => value arguments.
• get_object_taxonomies()Returns the names or objects of the taxonomies which are registered for the requested object or object type, such as a post object or post type name.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_the_terms()Retrieves the terms of the taxonomy that are attached to the post.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• block_core_breadcrumbs_get_term_ancestors_items()Generates breadcrumb items for hierarchical term ancestors.
• get_term_link()Generates a permalink for a taxonomy term archive.

Used by · 1

• render_block_core_breadcrumbs()Renders the `core/breadcrumbs` block on the server.

Source code

View on Trac ↗View on GitHub ↗

500function block_core_breadcrumbs_get_terms_breadcrumbs( $post_id, $post_type ) {501	$breadcrumb_items = array();502 503	// Get public taxonomies for this post type.504	$taxonomies = wp_filter_object_list(505		get_object_taxonomies( $post_type, 'objects' ),506		array(507			'publicly_queryable' => true,508			'show_in_rest'       => true,509		)510	);511 512	if ( empty( $taxonomies ) ) {513		return $breadcrumb_items;514	}515 516	/**517	 * Filters breadcrumb settings (taxonomy and term selection) for a post or post type.518	 *519	 * Allows developers to specify which taxonomy and term should be used in the520	 * breadcrumb trail when a post type has multiple taxonomies or when a post is521	 * assigned to multiple terms within a taxonomy.522	 *523	 * @since 7.0.0524	 *525	 * @param array  $settings {526	 *     Array of breadcrumb settings. Default empty array.527	 *528	 *     @type string $taxonomy Optional. Taxonomy slug to use for breadcrumbs.529	 *                            The taxonomy must be registered for the post type and have530	 *                            terms assigned to the post. If not found or has no terms,531	 *                            fall back to the first available taxonomy with terms.532	 *     @type string $term     Optional. Term slug to use when the post has multiple terms533	 *                            in the selected taxonomy. If the term is not found or not534	 *                            assigned to the post, fall back to the first term. If the535	 *                            post has only one term, that term is used regardless.536	 * }537	 * @param string $post_type The post type slug.538	 * @param int    $post_id   The post ID.539	 */540	$settings = apply_filters( 'block_core_breadcrumbs_post_type_settings', array(), $post_type, $post_id );541 542	$taxonomy_name = null;543	$terms         = array();544 545	// Try preferred taxonomy first if specified.546	if ( ! empty( $settings['taxonomy'] ) ) {547		foreach ( $taxonomies as $taxonomy ) {548			if ( $taxonomy->name === $settings['taxonomy'] ) {549				$post_terms = get_the_terms( $post_id, $taxonomy->name );550				if ( ! empty( $post_terms ) && ! is_wp_error( $post_terms ) ) {551					$taxonomy_name = $taxonomy->name;552					$terms         = $post_terms;553				}554				break;555			}556		}557	}558 559	// If no preferred taxonomy or it didn't have terms, find the first taxonomy with terms.560	if ( empty( $terms ) ) {561		foreach ( $taxonomies as $taxonomy ) {562			$post_terms = get_the_terms( $post_id, $taxonomy->name );563			if ( ! empty( $post_terms ) && ! is_wp_error( $post_terms ) ) {564				$taxonomy_name = $taxonomy->name;565				$terms         = $post_terms;566				break;567			}568		}569	}570 571	if ( ! empty( $terms ) ) {572		// Select which term to use.573		$term = reset( $terms );574 575		// Try preferred term if specified and post has multiple terms.576		if ( ! empty( $settings['term'] ) && count( $terms ) > 1 ) {577			foreach ( $terms as $candidate_term ) {578				if ( $candidate_term->slug === $settings['term'] ) {579					$term = $candidate_term;

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.