You are here

interface BlockRepositoryInterface in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/block/src/BlockRepositoryInterface.php \Drupal\block\BlockRepositoryInterface

Hierarchy

Expanded class hierarchy of BlockRepositoryInterface

All classes that implement BlockRepositoryInterface

1 file declares its use of BlockRepositoryInterface
BlockPageVariant.php in core/modules/block/src/Plugin/DisplayVariant/BlockPageVariant.php
Contains \Drupal\block\Plugin\DisplayVariant\BlockPageVariant.

File

core/modules/block/src/BlockRepositoryInterface.php, line 10
Contains \Drupal\block\BlockRepositoryInterface.

Namespace

Drupal\block
View source
interface BlockRepositoryInterface {

  /**
   * Returns an array of regions and their block entities.
   *
   * @param \Drupal\Core\Cache\CacheableMetadata[] $cacheable_metadata
   *   (optional) List of CacheableMetadata objects, keyed by region. This is
   *   by reference and is used to pass this information back to the caller.
   *
   * @return array
   *   The array is first keyed by region machine name, with the values
   *   containing an array keyed by block ID, with block entities as the values.
   */
  public function getVisibleBlocksPerRegion(array &$cacheable_metadata = []);

}

Members

Namesort descending Modifiers Type Description Overrides
BlockRepositoryInterface::getVisibleBlocksPerRegion public function Returns an array of regions and their block entities. 1