interface LayoutInterface in Drupal 10

Provides an interface for static Layout plugins.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Component\Plugin\DerivativeInspectionInterface; interface \Drupal\Component\Plugin\ConfigurableInterface; interface \Drupal\Component\Plugin\DependentPluginInterface; interface \Drupal\Core\Plugin\ContextAwarePluginInterface
  • interface \Drupal\Core\Layout\LayoutInterface

7 files declare their use of LayoutInterface

ConfigureSectionForm.php in core/modules/layout_builder/src/Form/ConfigureSectionForm.php

EntityDisplayWithLayoutInterface.php in core/modules/field_layout/src/Display/EntityDisplayWithLayoutInterface.php

FieldLayoutEntityDisplayTrait.php in core/modules/field_layout/src/Entity/FieldLayoutEntityDisplayTrait.php

LayoutPluginManagerTest.php in core/tests/Drupal/Tests/Core/Layout/LayoutPluginManagerTest.php

SectionComponentTest.php in core/modules/layout_builder/tests/src/Unit/SectionComponentTest.php

... See full list

File

core/lib/Drupal/Core/Layout/LayoutInterface.php, line 14

Namespace

Drupal\Core\Layout

interface LayoutInterface extends PluginInspectionInterface, DerivativeInspectionInterface, ConfigurableInterface, DependentPluginInterface, ContextAwarePluginInterface {

  /**
   * Build a render array for layout with regions.
   *
   * @param array $regions
   *   An associative array keyed by region name, containing render arrays
   *   representing the content that should be placed in each region.
   *
   * @return array
   *   Render array for the layout with regions.
   */
  public function build(array $regions);

  /**
   * {@inheritdoc}
   *
   * @return \Drupal\Core\Layout\LayoutDefinition
   */
  public function getPluginDefinition();

}