# Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [4.1.0] - 2026-02-23 ### Added - Moved framework code to `packages` folder that is developed separately. - New `Prelude` class for development. It's used to bundle in-house dependencies. - New `CrumbCollection::hasWhere()` method for checking if a crumb of a given type satisfies a callback condition. - `Post::postCrumbExists()` to determine if a specific post has been added to the collection. - `PostType::postTypeCrumbExists()` to determine if a specific post type crumb has been added to the collection. - `Term::termCrumbExists()` to determine if a specific term crumb has been added to the collection. - More robust `Path` assembler. This version checks the path with a segment removed during the loop rather than splitting into parts, which is more accurate when given a full path. ### Changed - The `Block` interface now follows a standardized method of passing parameters into its `render()` method. This ensures that there's a single class instance that can be used multiple times without creating a new class. - Hook callbacks are now private class methods and use PHP's first-class callable syntax. - Now using the default `blocks-manifest.json` instead of `manifest.json` because custom naming doesn't have full support in development. - `Crumb` classes' properties are now set to public for accessing them outside the class (used for checks if a particular crumb is in a collection). - General code updates, including better type hinting and other cleanup. ### Fixed - The default `mapRewriteTags` attribute has cleaner handling by only overwriting the default attribute value and merging with what's already set in `block.json`. ## [4.0.0] - 2025-11-08 ### Added - **Rewrite Tags** block option, which lets you select which post types map to rewrite tags (e.g., `%category%`, `%author%`, etc.). Only post types with rewrite tags in their slugs appear as options. - **Post Taxonomies** block option, which lets you choose which taxonomy's terms to display in the breadcrumb trail for single post views. - **Labels** block option, which lets you customize a subset of labels that most commonly need to be changed: - Home - Search Results - 404 - The Home label can also be edited directly from the content canvas. - Content-only editing support for the block. When enabled, the toolbar controls no longer appear. However, users can edit the Home label directly in the editor canvas. - Block supports: - `ariaLabel`: WordPress doesn't display a UI control for this, but it's possible to change the default `Breadcrumbs` label via the Code Editor view. - `shadow`: you can now add shadows—not sure how I missed adding this before. - Time-based breadcrumbs: - Hour, minute, and second archive breadcrumbs. - Posts with hour, minute, and seconds in their permalink structure now show those crumbs (assuming rewrite mapping is enabled). - A `JsonLinkedData` markup class for outputting JSON-LD breadcrumbs in the site head. This is not output by default, but developers can opt in. - Action hooks: - `x3p0/breadcrumbs/init` - Fires just before the plugin's default service providers are registered. - `x3p0/breadcrumbs/register` - Fires just after the plugin's default service providers are registered. - `x3p0/breadcrumbs/boot` - Fires just after the plugin's default services providers have been booted. - Filter hooks: - `x3p0/breadcrumbs/resolve/query-type` - Allows filtering the primary query type used to determine the breadcrumbs for the current page. - `namespace` argument for the markup configuration, which allows controlling the HTML class prefixes or each element (defaults to `breadcrumbs`). ### Changed - A complete overhaul of the public-facing developer API. The plugin is no longer compatible with classes/functions earlier than 4.0.0 for people who were extending it with PHP. - Because the new Rewrite Tags and Post Taxonomies block options were added, the block no longer defaults to display a category for posts. This can be set manually by the user, within patterns, or within theme templates. - Under the hood, for the same reason as above, the PHP code no longer auto-sets the category taxonomy for posts when the permalink structure is set to `%postname%`. This was a relic from the code when users didn't have direct control over the settings. - All block panels now use the Tools Panel component, which brings them up to date with the Core blocks in WordPress 6.9. - The icon-based block attributes have been merged into single attributes. The block is still backwards compatible with the old attributes with no current plans for removing their support: - `separator` and `separatorType` → `separatorIcon` - `homePrefix` and `homePrefixType`→ `homeIcon` - The block preview in the content canvas now shows Home → Ancestor → Parent → Current. This change was implemented so that users can better see the effects of removing the first and/or last breadcrumbs in the editor. - The `justifyContent` attribute is strictly limited to `left`, `center`, and `right`. These have always been the only options. It's just defined in `block.json` now. - The `404 Not Found` label has been changed to `Page not found` to match WordPress's default output for 404 document titles. - The plugin now uses Composer for autoloading instead of the previous custom `Autoload` class. - All nested elements for the block now use the `.wp-block-x3p0-breadcrumbs__` prefix instead of `.breadcrumbs__`. ### Fixed - Post taxonomy terms on single post views are no longer sorted by the plugin. This allows third-party plugins to manage the sorting. This is particularly important for SEO plugins that allow you to set a "primary" term for a post. - Correctly determine when a weekly archive is being displayed. ### Removed - Support for editing the Block layout. Previously, you could change how the block wrapped, but this was just UI clutter that served no practical purpose. - Call to `wp_set_script_translations()` for the block. WordPress already handles this through the normal block registration process. ## [3.1.0] - 2025-10-05 ### Added - New separator color support for `theme.json` for the block. This can be set via `settings.custom.x3p0/breadcrumbs.color.separator`. ### Fixed - When using the home icon option for the block, the spacing for it and the home label now inherit the `gap` (block spacing) setting, which was added in v.3.0.0. - The `Markup/Html` class correctly renders the HTML attributes on crumbs. Previously, the attributes were malformed. ## [3.0.0] - 2025-09-26 ### Added - `spacing.blockGap` support was added, which now lets theme authors and users control the spacing between breadcrumb items via the standard block gap/spacing design tools. - WordPress 6.9: Theme authors should switch to styling this via `styles.blocks.x3p0/breadcrumbs.spacing.blockGap` (as of the current release date, this works with the Gutenberg plugin enabled). - WordPress 6.8: `blockGap` styling doesn't work in `theme.json`, so this is needed in the `css` field for the block: `&.is-layout-flex { gap: var(--wp--preset--spacing--20); }` - The old `settings.x3p0/breadcrumbs.blockGap` configuration will still work. - The fallback `blockGap` style for the block is `0.5rem`. - Horizontal flex `layout` support was added, primarily as a requirement for `blockGap` to work. This is not configurable, but it does use the WordPress layout implementation instead of custom CSS. ### Fixed - Corrected handling of the option for showing breadcrumbs on the front page. Previously, they did not appear if enabled. - Editor scripts translations should now work. Previously, a call to `wp_set_script_translations()` was missing. - The `Container` interface previously incorrectly extended the `Bootable` interface. - Accessibility: The `aria-current` attribute is now applied to the last breadcrumb item. ### Changed - The plugin now only supports WordPress 6.8. Any back-compat code for older versions has been removed. - Interactivity router region support moved to the `container_attr` array for `Markup` classes. These attributes are no longer forcefully injected and can be overwritten. - The `breadcrumbs` value is now applied to the `data-wp-router-region` attribute. - When filtering `x3p0/breadcrumbs/builder/pre/build` a type error will be thrown if a non-null value other than `X3P0\Breadcrumbs\Contracts\Builder` implementation is returned. ### Removed - The `Plugin` class was removed and renamed to `App`. This should not affect old installations since third-party devs should have been using the `plugin()` helper function. - The `Trail` class has been removed, which was deprecated in version 2.0.0. ## [2.1.0] - 2025-08-15 ### Added - New support for the WordPress `wp_register_block_types_from_metadata_collection()` function, which simplifies block registration in WP 6.8+. Currently, 6.6 and 6.7 registration methods are supported but will likely be removed in the next version. ### Changed - Removed an unnecessary import of the `DirectoryIterator` class. ### Fixed - Corrected a fatal error in rare circumstances where posts have ancestors of a post type that is no longer registered (e.g., an attachment uploaded to a product). The code now checks that a post type exists before attempting to grab a post object. - The block now supports interactive regions, which correctly adds the page 2, 3, and so on crumbs when a user has enhanced pagination (client-side navigation) enabled for the Query Loop block. Note that this only works if the Breadcrumbs block already appear on the initial page. ## [2.0.1] - 2024-10-31 ### Changed - The `Assembler\PostType` and `Crumb\PostType` classes both now have a `$type` property that can be set when initializing the classes. Previously, these were mismatched, and one was named `$post_type`. ### Fixed - A call to the `Crumb\PostType` class used the wrong parameter name of `$post_type` instead of `$type`. ## [2.0.0] - 2024-10-21 ### New - **Block:** Added an option for removing the first breadcrumb. - **Block:** Added a "Markup Style" option for selecting between plain HTML, Microdata, and RDFa (default) markup. - Overhauled the plugin to use a more robust OOP structure that will allow it to be extended. - Several new hooks that act as extension points for third-party developers: - `x3p0/breadcrumbs/environment` - `x3p0/breadcrumbs/builder/pre/build` - `x3p0/breadcrumbs/builder/config` - `x3p0/breadcrumbs/markup/config` ### Deprecated - The `X3P0\Breadcrumbs\Trail` static class should no longer be used and will be removed in version 3.0.0. Instead, use the existing `Environment`, `Builder`, and `Markup` implementations to build breadcrumbs or the **Breadcrumbs** block. ### Removed - The PHP APIs are no longer backward compatible with version 1.0.x. - Setting the HTML structure via options is no longer supported. Instead, use a `Markup` class. ## [1.0.1] - 2023-10-25 ### Changed - Block API bumped to version 3. ### Removed - Removed the `x3p0/breadcrumbs/trail` filter hook at the request of a reviewer for the WordPress.org Plugin Review Team. ## [1.0.0] - 2023-07-15 ### Added - 🎉 Literally everything. This is version 1.0, after all.