1. Home
  2. Components
  3. breadcrumbs()

breadcrumbs()

Show the current page's location in a hierarchical structure.

breadcrumbs( array $links [, array $options = [] ] ) : string

Parameters

$links array Required Associative array link-title => link.

$options array Optional Additional options.

Available options

Name Type Default Description
id string '' Wrapper ID.
class string '' Class for wrapper.
attributes array [] Array of custom attributes.
item_class string '' Class for item.
divider string '/' Items divider.

Basic Usage

echo breadcrumbs([
    'Home'    => 'index.php',
    'Library' => 'library.php',
    'Data'    => 'data.php',
]);

HTML Output

  1. Home
  2. Library
  3. Data
<ol class="breadcrumb" aria-label="breadcrumb">
    <li class="breadcrumb-item"><a href="index.php">Home</a></li>
    <li class="breadcrumb-item"><a href="library.php">Library</a></li>
    <li class="breadcrumb-item active" aria-current="page">Data</li>
</ol>

Dividers

Dividers can be changed by adding divider.

echo breadcrumbs([
    'Home'    => 'index.php',
    'Library' => 'library.php',
    'Data'    => 'data.php',
], [
    'divider' => '>',
]);

HTML Output

  1. Home
  2. Library
  3. Data
<ol class="breadcrumb" style="--bs-breadcrumb-divider: '>';" aria-label="breadcrumb">
    <li class="breadcrumb-item"><a href="index.php">Home</a></li>
    <li class="breadcrumb-item"><a href="library.php">Library</a></li>
    <li class="breadcrumb-item active" aria-current="page">Data</li>
</ol>
Report issue Edit on GitHub