interface BreadcrumbBuilderInterface in Drupal 10

Defines an interface for classes that build breadcrumbs.

Hierarchy

• interface \Drupal\Core\Breadcrumb\BreadcrumbBuilderInterface

7 files declare their use of BreadcrumbBuilderInterface

BookBreadcrumbBuilder.php in core/modules/book/src/BookBreadcrumbBuilder.php

CommentBreadcrumbBuilder.php in core/modules/comment/src/CommentBreadcrumbBuilder.php

ForumBreadcrumbBuilderBase.php in core/modules/forum/src/Breadcrumb/ForumBreadcrumbBuilderBase.php

HelpBreadcrumbBuilder.php in core/modules/help_topics/src/HelpBreadcrumbBuilder.php

PathBasedBreadcrumbBuilder.php in core/modules/system/src/PathBasedBreadcrumbBuilder.php

... See full list

File

core/lib/Drupal/Core/Breadcrumb/BreadcrumbBuilderInterface.php, line 10

Namespace

Drupal\Core\Breadcrumb

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\Breadcrumb\Breadcrumb
   *   A breadcrumb.
   */
  public function build(RouteMatchInterface $route_match);

}