[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

/wp-includes/blocks/ -> breadcrumbs.php (summary)

Server-side rendering of the `core/breadcrumbs` block.

File Size: 611 lines (19 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 10 functions

  render_block_core_breadcrumbs()
  block_core_breadcrumbs_is_paged()
  block_core_breadcrumbs_create_page_number_item()
  block_core_breadcrumbs_create_item()
  block_core_breadcrumbs_get_post_title()
  block_core_breadcrumbs_get_hierarchical_post_type_breadcrumbs()
  block_core_breadcrumbs_get_term_ancestors_items()
  block_core_breadcrumbs_get_archive_breadcrumbs()
  block_core_breadcrumbs_get_terms_breadcrumbs()
  register_block_core_breadcrumbs()

Functions
Functions that are not part of a class:

render_block_core_breadcrumbs( $attributes, $content, $block )   X-Ref
Renders the `core/breadcrumbs` block on the server.

return: string Returns the post breadcrumb for hierarchical post types.
param: array    $attributes Block attributes.
param: string   $content    Block default content.
param: WP_Block $block      Block instance.

block_core_breadcrumbs_is_paged()   X-Ref
No description

block_core_breadcrumbs_create_page_number_item( $query_var = 'paged' )   X-Ref
Creates a "Page X" breadcrumb item for paginated views.

return: array The "Page X" breadcrumb item data.
param: string $query_var Optional. Query variable to get current page number. Default 'paged'.

block_core_breadcrumbs_create_item( $text, $is_paged = false )   X-Ref
Creates a breadcrumb item that's either a link or current page item.

When paginated (is_paged is true), creates a link to page 1.
Otherwise, creates a span marked as the current page.

return: array The breadcrumb item data.
param: string $text       The text content.
param: bool   $is_paged   Whether we're on a paginated view.

block_core_breadcrumbs_get_post_title( $post_id_or_object )   X-Ref
Gets a post title with fallback for empty titles.

return: string The post title or fallback text.
param: int|WP_Post $post_id_or_object The post ID or post object.

block_core_breadcrumbs_get_hierarchical_post_type_breadcrumbs( $post_id )   X-Ref
Generates breadcrumb items from hierarchical post type ancestors.

return: array Array of breadcrumb item data.
param: int    $post_id   The post ID.

block_core_breadcrumbs_get_term_ancestors_items( $term_id, $taxonomy )   X-Ref
Generates breadcrumb items for hierarchical term ancestors.

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

return: array Array of breadcrumb item data for ancestors.
param: int    $term_id  The term ID.
param: string $taxonomy The taxonomy name.

block_core_breadcrumbs_get_archive_breadcrumbs()   X-Ref
Generates breadcrumb items for archive pages.

Handles taxonomy archives, post type archives, date archives, and author archives.
For hierarchical taxonomies, includes ancestor terms in the breadcrumb trail.

return: array Array of breadcrumb item data.

block_core_breadcrumbs_get_terms_breadcrumbs( $post_id, $post_type )   X-Ref
Generates breadcrumb items from taxonomy terms.

Finds the first publicly queryable taxonomy with terms assigned to the post
and generates breadcrumb links, including hierarchical term ancestors if applicable.

return: array Array of breadcrumb item data.
param: int    $post_id   The post ID.
param: string $post_type The post type name.

register_block_core_breadcrumbs()   X-Ref
Registers the `core/breadcrumbs` block on the server.




Generated : Sat Jun 13 09:38:55 2026 Cross-referenced by PHPXref