Breadcrumbs

In this article


Display a breadcrumb trail showing the path to the current page.

  • Name: core/breadcrumbs
  • Category: theme
  • API Version: 3
  • Block Type: Dynamic (server-rendered)

Attributes

Defined via the attributes property in block.json.

Attribute Type Default Description
prefersTaxonomy boolean false
separator string "/"
showHomeItem boolean true
showCurrentItem boolean true
showOnHomePage boolean false

Supports

Defined via the supports property in block.json.

Context

Defined via the usesContext and providesContext properties in block.json.

Uses context:

  • postId
  • postType
  • templateSlug

Block Markup

This is a dynamic block. It is rendered on the server and does not save HTML in post content.

In post content, it is stored as a block comment:

<!-- wp:breadcrumbs /-->

Source