Defines an interface for classes that build breadcrumbs.

Implemented by

Hierarchy

Expanded class hierarchy of BreadcrumbBuilderInterface

File

core/lib/Drupal/Core/Breadcrumb/BreadcrumbBuilderInterface.php, line 15
Contains \Drupal\Core\Breadcrumb\BreadcrumbBuilderInterface.

Namespace

Drupal\Core\Breadcrumb
View source
interface BreadcrumbBuilderInterface {

  /**
   * Whether this breadcrumb builder should be used to build the breadcrumb.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The current route match.
   *
   * @return bool
   *   TRUE if this builder should be used or FALSE to let other builders
   *   decide.
   */
  public function applies(RouteMatchInterface $route_match);

  /**
   * Builds the breadcrumb.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The current route match.
   *
   * @return \Drupal\Core\Link[]
   *   An array of links for the breadcrumb. Returning an empty array will
   *   suppress all breadcrumbs.
   */
  public function build(RouteMatchInterface $route_match);

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
BreadcrumbBuilderInterface::applies public function Whether this breadcrumb builder should be used to build the breadcrumb.
BreadcrumbBuilderInterface::build public function Builds the breadcrumb.