PHPackages arraypress/wp-breadcrumbs - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. arraypress/wp-breadcrumbs ActiveLibrary[Utility & Helpers](/categories/utility) arraypress/wp-breadcrumbs ========================= A lightweight fluent builder for generating accessible HTML breadcrumb navigation with Schema.org microdata, ARIA attributes, and WordPress admin support. 021PHP Since Feb 28Pushed 4mo agoCompare [ Source](https://github.com/arraypress/wp-breadcrumbs)[ Packagist](https://packagist.org/packages/arraypress/wp-breadcrumbs)[ RSS](/packages/arraypress-wp-breadcrumbs/feed)WikiDiscussions main Synced today READMEChangelogDependenciesVersions (1)Used By (1) WordPress Breadcrumbs ===================== [](#wordpress-breadcrumbs) A lightweight fluent builder for generating accessible HTML breadcrumb navigation in WordPress. Supports Schema.org microdata, ARIA attributes, icons (including dashicons), custom separators, and flexible configuration. Installation ------------ [](#installation) ``` composer require arraypress/wp-breadcrumbs ``` Usage ----- [](#usage) ### Fluent Builder [](#fluent-builder) ``` use ArrayPress\Breadcrumbs\Breadcrumbs; Breadcrumbs::create() ->add( 'Home', '/', 'dashicons-admin-home' ) ->add( 'Products', '/products/' ) ->add_current( 'Widget Pro' ) ->display(); ``` ### One-Liners [](#one-liners) ``` // Render from an array of items echo render_breadcrumbs( [ [ 'label' => 'Home', 'url' => '/' ], [ 'label' => 'Blog', 'url' => '/blog/' ], [ 'label' => 'My Post' ], ] ); // Echo directly display_breadcrumbs( [ [ 'label' => 'Dashboard', 'url' => admin_url() ], [ 'label' => 'Settings' ], ] ); ``` ### Helper Function [](#helper-function) ``` // Create a builder via helper create_breadcrumbs() ->add( 'Buckets', $buckets_url, 'dashicons-cloud' ) ->add( $bucket_name, $bucket_url ) ->add_current( $prefix ) ->display(); ``` ### With Icons [](#with-icons) ``` // WordPress dashicons (auto-detected by prefix) Breadcrumbs::create() ->add( 'Home', '/', 'dashicons-admin-home' ) ->add( 'Media', '/media/', 'dashicons-admin-media' ) ->add_current( 'image.jpg' ) ->display(); // Raw HTML icons (SVG, img, etc.) Breadcrumbs::create() ->add( 'Home', '/', '...' ) ->add_current( 'Page' ) ->display(); ``` ### Custom Configuration [](#custom-configuration) ``` Breadcrumbs::create( [ 'separator' => '/', 'aria_label' => 'File navigation', 'nav_class' => 'my-breadcrumbs', ] ) ->add( 'Root', '/' ) ->add( 'Documents', '/docs/' ) ->add_current( 'readme.md' ) ->display(); // Or configure via fluent methods Breadcrumbs::create() ->separator( '»' ) ->aria_label( 'Site navigation' ) ->nav_class( 'custom-nav' ) ->add( 'Home', '/' ) ->add_current( 'About' ) ->display(); ``` ### Bulk Items [](#bulk-items) ``` $items = [ [ 'label' => 'Home', 'url' => '/', 'icon' => 'dashicons-admin-home' ], [ 'label' => 'Products', 'url' => '/products/' ], [ 'label' => 'Widgets', 'url' => '/products/widgets/' ], [ 'label' => 'Widget Pro' ], ]; Breadcrumbs::create()->add_items( $items )->display(); ``` ### Inspection [](#inspection) ``` $breadcrumbs = Breadcrumbs::create() ->add( 'Home', '/' ) ->add( 'Blog', '/blog/' ) ->add_current( 'Post' ); $breadcrumbs->count(); // 3 $breadcrumbs->has_items(); // true $breadcrumbs->is_empty(); // false $breadcrumbs->first(); // Item { label: 'Home', url: '/' } $breadcrumbs->last(); // Item { label: 'Post', url: null } $breadcrumbs->items(); // [ Item, Item, Item ] ``` ### Array & JSON Output [](#array--json-output) ``` $breadcrumbs = Breadcrumbs::create() ->add( 'Home', '/' ) ->add_current( 'About' ); $breadcrumbs->to_array(); // Array of item data echo json_encode( $breadcrumbs ); // JSON serializable echo (string) $breadcrumbs; // Rendered HTML ``` ### Item Value Object [](#item-value-object) ``` use ArrayPress\Breadcrumbs\Item; $item = new Item( 'Products', '/products/', 'dashicons-cart' ); $item->label(); // 'Products' $item->url(); // '/products/' $item->icon(); // 'dashicons-cart' $item->attributes(); // [] $item->is_link(); // true $item->has_icon(); // true $item->to_array(); // [ 'label' => ..., 'url' => ..., ... ] ``` HTML Output ----------- [](#html-output) The rendered HTML follows semantic best practices: ``` Home › About ``` Methods ------- [](#methods) ### Builder [](#builder) MethodReturnsDescription`create()``static`Factory method (static)`add()``static`Add an item with label, url, icon`add_home()``static`Add a home/root item`add_current()``static`Add the current page (no link)`add_items()``static`Add multiple items from array`reset()``static`Remove all items### Configuration [](#configuration) MethodReturnsDescription`separator()``static`Set separator string`aria_label()``static`Set nav ARIA label`nav_class()``static`Set nav element CSS class`list_class()``static`Set ol element CSS class`item_class()``static`Set li element CSS class`separator_class()``static`Set separator li CSS class`active_class()``static`Set active item CSS class### Getters [](#getters) MethodReturnsDescription`items()``Item[]`All breadcrumb items`count()``int`Number of items`has_items()``bool`Whether items exist`is_empty()``bool`Whether no items exist`first()``?Item`First item or null`last()``?Item`Last item or null### Rendering [](#rendering) MethodReturnsDescription`render()``string`Get breadcrumbs as HTML`display()``void`Echo breadcrumbs HTML### Output [](#output) MethodReturnsDescription`to_array()``array`Items as data arrays### Item Methods [](#item-methods) MethodReturnsDescription`label()``string`Display text`url()``?string`URL or null for current item`icon()``?string`Icon HTML or dashicon class`attributes()``array`Extra HTML attributes`is_link()``bool`Whether item has a URL`has_icon()``bool`Whether item has an icon`to_array()``array`Item data as associative array### Configuration Defaults [](#configuration-defaults) OptionDefaultDescription`separator``›` (›)Item separator`aria_label``Breadcrumb`Nav ARIA label`nav_class``arraypress-breadcrumbs`Nav CSS class`list_class``arraypress-breadcrumbs__list`List CSS class`item_class``arraypress-breadcrumbs__item`Item CSS class`separator_class``arraypress-breadcrumbs__separator`Separator CSS class`active_class``arraypress-breadcrumbs__item--active`Active item CSS classRequirements ------------ [](#requirements) - PHP 7.4+ - WordPress 5.0+ License ------- [](#license) GPL-2.0-or-later ### Health Score 18 — LowBetter than 8% of packages Maintenance52 Moderate activity, may be stable Popularity2 Limited adoption so far Community8 Small or concentrated contributor base Maturity12 Early-stage or recently created project Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/cd6eb8aff0903d87eb674d1ba3c5f3653899c0d7661504eb0deb7798ed86b643?d=identicon)[arraypress](/maintainers/arraypress) --- Top Contributors [![arraypress](https://avatars.githubusercontent.com/u/22668877?v=4)](https://github.com/arraypress "arraypress (2 commits)") ### Embed Badge ![Health badge](/badges/arraypress-wp-breadcrumbs/health.svg) ``` [![Health](https://phpackages.com/badges/arraypress-wp-breadcrumbs/health.svg)](https://phpackages.com/packages/arraypress-wp-breadcrumbs) ``` PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)