LayoutDefinition::$regions

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Layout/LayoutDefinition.php \Drupal\Core\Layout\LayoutDefinition::regions
  2. 10 core/lib/Drupal/Core/Layout/LayoutDefinition.php \Drupal\Core\Layout\LayoutDefinition::regions
  3. 11.x core/lib/Drupal/Core/Layout/LayoutDefinition.php \Drupal\Core\Layout\LayoutDefinition::regions

An associative array of regions in this layout.

The key of the array is the machine name of the region, and the value is 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.

Type: array

File

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

Class

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

Namespace

Drupal\Core\Layout

Code

protected $regions = [];

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