block_core_breadcrumbs_get_archive_breadcrumbs(): 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.

Return value

array

Array of breadcrumb item data.

Performance profile

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

Scaling

Constant

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

Instructions

9–78

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

Plugin surface

1 hook

Third-party callbacks on 'post_type_archive_title' 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_term()one call below block_core_breadcrumbs_get_archive_breadcrumbs()

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

One number would be a lie: the work depends on which branch runs. These are every distinct cost block_core_breadcrumbs_get_archive_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_archive_breadcrumbs() runs, in this order:

1. 1
   apply_filters( post_type_archive_title )filterline 460 (+99 into the body)

   Filters the post type archive title.

Uses · 14

• is_date()Determines whether the query is for an existing date archive.
• get_query_var()Retrieves the value of a query variable in the WP_Query class.
• block_core_breadcrumbs_is_paged()Checks if we're on a paginated view (page 2 or higher).
• get_year_link()Retrieves the permalink for the year archives.
• date_i18n()Retrieves the date in localized format, based on a sum of Unix timestamp and timezone offset in seconds.
• get_month_link()Retrieves the permalink for the month archives with year.
• block_core_breadcrumbs_create_item()Creates a breadcrumb item that's either a link or current page item.
• block_core_breadcrumbs_create_page_number_item()Creates a "Page X" breadcrumb item for paginated views.
• get_queried_object()Retrieves the currently queried object.
• block_core_breadcrumbs_get_term_ancestors_items()Generates breadcrumb items for hierarchical term ancestors.
• is_post_type_archive()Determines whether the query is for an existing post type archive page.
• get_post_type_object()Retrieves a post type object by name.

Used by · 1

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

Source code

View on Trac ↗View on GitHub ↗

361function block_core_breadcrumbs_get_archive_breadcrumbs() {362	$breadcrumb_items = array();363 364	// Date archive (check first since it doesn't have a queried object).365	if ( is_date() ) {366		$year  = get_query_var( 'year' );367		$month = get_query_var( 'monthnum' );368		$day   = get_query_var( 'day' );369 370		// Fallback to 'm' query var for plain permalinks.371		// Plain permalinks use ?m=YYYYMMDD format instead of separate query vars.372		if ( ! $year ) {373			$m = get_query_var( 'm' );374			if ( $m ) {375				$year  = substr( $m, 0, 4 );376				$month = substr( $m, 4, 2 );377				$day   = (int) substr( $m, 6, 2 );378			}379		}380 381		$is_paged = block_core_breadcrumbs_is_paged();382 383		if ( $year ) {384			if ( $month ) {385				// Year is linked if we have month.386				$breadcrumb_items[] = array(387					'label' => $year,388					'url'   => get_year_link( $year ),389				);390 391				if ( $day ) {392					// Month is linked if we have day.393					$breadcrumb_items[] = array(394						'label' => date_i18n( 'F', mktime( 0, 0, 0, $month, 1, $year ) ),395						'url'   => get_month_link( $year, $month ),396					);397					// Add day (current if not paginated, link if paginated).398					$breadcrumb_items[] = block_core_breadcrumbs_create_item(399						$day,400						$is_paged401					);402				} else {403					// Add month (current if not paginated, link if paginated).404					$breadcrumb_items[] = block_core_breadcrumbs_create_item(405						date_i18n( 'F', mktime( 0, 0, 0, $month, 1, $year ) ),406						$is_paged407					);408				}409			} else {410				// Add year (current if not paginated, link if paginated).411				$breadcrumb_items[] = block_core_breadcrumbs_create_item(412					$year,413					$is_paged414				);415			}416		}417 418		// Add pagination breadcrumb if on a paged date archive.419		if ( $is_paged ) {420			$breadcrumb_items[] = block_core_breadcrumbs_create_page_number_item();421		}422 423		return $breadcrumb_items;424	}425 426	// For other archive types, we need a queried object.427	$queried_object = get_queried_object();428 429	if ( ! $queried_object ) {430		return array();431	}432 433	$is_paged = block_core_breadcrumbs_is_paged();434 435	// Taxonomy archive (category, tag, custom taxonomy).436	if ( $queried_object instanceof WP_Term ) {437		$term     = $queried_object;438		$taxonomy = $term->taxonomy;439 440		// Add hierarchical term ancestors if applicable.

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.