function LayoutDefinition::getRegions

Same name in other branches
  1. 9 core/lib/Drupal/Core/Layout/LayoutDefinition.php \Drupal\Core\Layout\LayoutDefinition::getRegions()
  2. 8.9.x core/lib/Drupal/Core/Layout/LayoutDefinition.php \Drupal\Core\Layout\LayoutDefinition::getRegions()
  3. 10 core/lib/Drupal/Core/Layout/LayoutDefinition.php \Drupal\Core\Layout\LayoutDefinition::getRegions()

Gets the regions for this layout definition.

Return value

array[] The layout regions. The keys of the array are the machine names of the regions, and the values are an associative array with the following keys:

  • label: (string) The human-readable name of the region.

Any remaining keys may have special meaning for the given layout plugin, but are undefined here.

2 calls to LayoutDefinition::getRegions()
LayoutDefinition::getRegionLabels in core/lib/Drupal/Core/Layout/LayoutDefinition.php
Gets the human-readable region labels.
LayoutDefinition::getRegionNames in core/lib/Drupal/Core/Layout/LayoutDefinition.php
Gets the machine-readable region names.

File

core/lib/Drupal/Core/Layout/LayoutDefinition.php, line 488

Class

LayoutDefinition
Provides an implementation of a layout definition and its metadata.

Namespace

Drupal\Core\Layout

Code

public function getRegions() {
    return $this->regions;
}

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