BreadcrumbNode implements JsonSerializable
Represents a single breadcrumb node in the backend document header.
Breadcrumb nodes are used to build hierarchical navigation trails that help users understand their current location within the TYPO3 backend and navigate back through parent items.
Subject to change until v15 LTS
Table of Contents
Interfaces
- JsonSerializable
Properties
- $forceShowIcon : bool|null
- $icon : string|null
- $iconOverlay : string|null
- $identifier : string
- $label : string
- $route : BreadcrumbNodeRoute|null
Methods
- __construct() : mixed
- jsonSerialize() : array<string|int, mixed>
Properties
$forceShowIcon
public
bool|null
$forceShowIcon
= false
$icon
public
string|null
$icon
= null
$iconOverlay
public
string|null
$iconOverlay
= null
$identifier
public
string
$identifier
$label
public
string
$label
$route
public
BreadcrumbNodeRoute|null
$route
= null
Methods
__construct()
public
__construct(string $identifier, string $label[, string|null $icon = null ][, string|null $iconOverlay = null ][, BreadcrumbNodeRoute|null $route = null ][, bool|null $forceShowIcon = false ]) : mixed
Parameters
- $identifier : string
-
Unique identifier for this node (e.g., record UID, page ID, storage identifier)
- $label : string
-
Display text shown to the user
- $icon : string|null = null
-
Icon identifier from the icon registry (e.g., 'actions-page-open', 'apps-pagetree-root')
- $iconOverlay : string|null = null
-
Overlay icon identifier for additional visual context (e.g., 'overlay-new', 'overlay-hidden')
- $route : BreadcrumbNodeRoute|null = null
-
Navigation target when clicking the node. Null means node is not clickable (typically the current item)
- $forceShowIcon : bool|null = false
-
Forces icon display even in contexts where icons are normally hidden (e.g., module nodes)
jsonSerialize()
public
jsonSerialize() : array<string|int, mixed>