1. interface
  2. Drupal
  3. \
  4. block
  5. \
  6. BlockRepositoryInterface

BlockRepositoryInterface

interface BlockRepositoryInterface (View source)

Constants

REGIONS_VISIBLE

Return only visible regions.
REGIONS_ALL

Return all regions.

Methods

array
getVisibleBlocksPerRegion(array $cacheable_metadata = [])

Returns an array of regions and their block entities.

Details

at line 32
array getVisibleBlocksPerRegion(array $cacheable_metadata = [])

Returns an array of regions and their block entities.

Parameters

array $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 Value

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.