interface BlockRepositoryInterface

Same name in other branches
  1. 9 core/modules/block/src/BlockRepositoryInterface.php \Drupal\block\BlockRepositoryInterface
  2. 10 core/modules/block/src/BlockRepositoryInterface.php \Drupal\block\BlockRepositoryInterface
  3. 11.x core/modules/block/src/BlockRepositoryInterface.php \Drupal\block\BlockRepositoryInterface

Hierarchy

Expanded class hierarchy of BlockRepositoryInterface

All classes that implement BlockRepositoryInterface

2 files declare their use of BlockRepositoryInterface
BlockPageVariant.php in core/modules/block/src/Plugin/DisplayVariant/BlockPageVariant.php
PlaceBlockPageVariant.php in core/modules/block_place/src/Plugin/DisplayVariant/PlaceBlockPageVariant.php

File

core/modules/block/src/BlockRepositoryInterface.php, line 5

Namespace

Drupal\block
View source
interface BlockRepositoryInterface {
    
    /**
     * Return only visible regions.
     *
     * @see system_region_list()
     */
    const REGIONS_VISIBLE = 'visible';
    
    /**
     * Return all regions.
     *
     * @see system_region_list()
     */
    const REGIONS_ALL = 'all';
    
    /**
     * 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

Title Sort descending Modifiers Object type Summary Overrides
BlockRepositoryInterface::getVisibleBlocksPerRegion public function Returns an array of regions and their block entities. 1
BlockRepositoryInterface::REGIONS_ALL constant Return all regions.
BlockRepositoryInterface::REGIONS_VISIBLE constant Return only visible regions.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.