public function DisplayInterface::getAllBlockInfo

Returns the display-specific configuration of all blocks in this display.

For each block that exists in Drupal (e.g., the "Who's Online" block), multiple "configured instances" can be created (e.g., a "Who's been online in the last 5 minutes" instance and a "Who's been online in the last 60 minutes" instance). Each configured instance can be referenced by multiple displays (e.g., by a "regular" page, by an administrative page, and within one or more dashboards). This function returns the block instances that have been added to this display. Each key of the returned array is the block instance's configuration object name, and config() may be called on it in order to retrieve the full configuration that is shared across all displays. For each key, the value is an array of display-specific configuration, primarily the 'region' and 'weight', and anything else that affects the placement of the block within the layout rather than only the contents of the block.

Return value

array An array keyed on each block's configuration object name. Each value is an array of information that determines the placement of the block within a layout, including:

• region: The region in which to display the block (for bound displays only).
• region-type: The type of region that is most appropriate for the block. Usually one of 'header', 'footer', 'nav', 'content', 'aside', or 'system', though custom region types are also allowed. This is primarily specified by unbound displays, where specifying a specific region name is impossible, because different layouts come with different regions.
• weight: Within a region, blocks are rendered from low to high weight.

File

drupal/core/modules/layout/lib/Drupal/layout/Config/DisplayInterface.php, line 65

Definition of Drupal\layout\Config\DisplayInterface

Class

DisplayInterface

Interface describing a Display configuration object.

Namespace

Code

public function getAllBlockInfo();