LayoutInterface.php

Same filename in other branches
  1. 8.9.x core/lib/Drupal/Core/Layout/LayoutInterface.php
  2. 10 core/lib/Drupal/Core/Layout/LayoutInterface.php
  3. 11.x core/lib/Drupal/Core/Layout/LayoutInterface.php

Namespace

Drupal\Core\Layout

File

core/lib/Drupal/Core/Layout/LayoutInterface.php

View source
<?php

namespace Drupal\Core\Layout;

use Drupal\Component\Plugin\DerivativeInspectionInterface;
use Drupal\Component\Plugin\PluginInspectionInterface;
use Drupal\Component\Plugin\ConfigurableInterface;
use Drupal\Component\Plugin\DependentPluginInterface;
use Drupal\Core\Plugin\ContextAwarePluginInterface;

/**
 * Provides an interface for static Layout plugins.
 */
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();

}

Interfaces

Title Deprecated Summary
LayoutInterface Provides an interface for static Layout plugins.

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