class Layout
Same name in this branch
- 11.x core/lib/Drupal/Core/Layout/Annotation/Layout.php \Drupal\Core\Layout\Annotation\Layout
Same name in other branches
- 9 core/lib/Drupal/Core/Layout/Annotation/Layout.php \Drupal\Core\Layout\Annotation\Layout
- 8.9.x core/lib/Drupal/Core/Layout/Annotation/Layout.php \Drupal\Core\Layout\Annotation\Layout
- 10 core/lib/Drupal/Core/Layout/Annotation/Layout.php \Drupal\Core\Layout\Annotation\Layout
- 10 core/lib/Drupal/Core/Layout/Attribute/Layout.php \Drupal\Core\Layout\Attribute\Layout
Defines a Layout attribute object.
Layouts are used to define a list of regions and then output render arrays in each of the regions, usually using a template.
Plugin Namespace: Plugin\Layout
Hierarchy
- class \Drupal\Component\Plugin\Attribute\AttributeBase implements \Drupal\Component\Plugin\Attribute\AttributeInterface
Expanded class hierarchy of Layout
See also
\Drupal\Core\Layout\LayoutInterface
\Drupal\Core\Layout\LayoutDefault
\Drupal\Core\Layout\LayoutPluginManager
9 files declare their use of Layout
- BlankLayout.php in core/
modules/ layout_builder/ src/ Plugin/ Layout/ BlankLayout.php - LayoutBuilderTestPlugin.php in core/
modules/ layout_builder/ tests/ modules/ layout_builder_test/ src/ Plugin/ Layout/ LayoutBuilderTestPlugin.php - LayoutPluginManager.php in core/
lib/ Drupal/ Core/ Layout/ LayoutPluginManager.php - LayoutTestDependenciesPlugin.php in core/
modules/ system/ tests/ modules/ layout_test/ src/ Plugin/ Layout/ LayoutTestDependenciesPlugin.php - LayoutTestPlugin.php in core/
modules/ system/ tests/ modules/ layout_test/ src/ Plugin/ Layout/ LayoutTestPlugin.php
36 string references to 'Layout'
- AjaxBlockTest::testAddAjaxBlock in core/
modules/ layout_builder/ tests/ src/ FunctionalJavascript/ AjaxBlockTest.php - Tests configuring a field block for a user field.
- field.field.node.article.layout_builder__layout.yml in core/
profiles/ demo_umami/ config/ install/ field.field.node.article.layout_builder__layout.yml - core/profiles/demo_umami/config/install/field.field.node.article.layout_builder__layout.yml
- field.field.node.page.layout_builder__layout.yml in core/
profiles/ demo_umami/ config/ install/ field.field.node.page.layout_builder__layout.yml - core/profiles/demo_umami/config/install/field.field.node.page.layout_builder__layout.yml
- field.field.node.recipe.layout_builder__layout.yml in core/
profiles/ demo_umami/ config/ install/ field.field.node.recipe.layout_builder__layout.yml - core/profiles/demo_umami/config/install/field.field.node.recipe.layout_builder__layout.yml
- InspectionTest::testInspection in core/
tests/ Drupal/ KernelTests/ Core/ Plugin/ InspectionTest.php - Ensure the test plugins correctly implement getPluginId() and getPluginDefinition().
File
-
core/
lib/ Drupal/ Core/ Layout/ Attribute/ Layout.php, line 23
Namespace
Drupal\Core\Layout\AttributeView source
class Layout extends Plugin {
/**
* Any additional properties and values.
*
* @var array
*
* @see \Drupal\Core\Layout\LayoutDefinition::$additional
*/
public readonly array $additional;
/**
* Constructs a Layout attribute.
*
* @param string $id
* The plugin ID.
* @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $label
* (optional) The human-readable name. @todo Deprecate optional label in
* https://www.drupal.org/project/drupal/issues/3392572.
* @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $category
* (optional) The human-readable category. @todo Deprecate optional category
* in https://www.drupal.org/project/drupal/issues/3392572.
* @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $description
* (optional) The description for advanced layouts.
* @param string|null $template
* (optional) The template file to render the layout.
* @param string $theme_hook
* (optional) The template hook to render the layout.
* @param string|null $path
* (optional) Path (relative to the module or theme) to resources like icon or template.
* @param string|null $library
* (optional) The asset library.
* @param string|null $icon
* (optional) The path to the preview image (relative to the 'path' given).
* @param string[][]|null $icon_map
* (optional) The icon map.
* @param array $regions
* (optional) An associative array of regions in this layout.
* @param string|null $default_region
* (optional) The default region.
* @param class-string $class
* (optional) The layout plugin class.
* @param \Drupal\Core\Plugin\Context\ContextDefinitionInterface[] $context_definitions
* (optional) The context definition.
* @param array $config_dependencies
* (optional) The config dependencies.
* @param class-string|null $deriver
* (optional) The deriver class.
* @param mixed $additional
* (optional) Additional properties passed in that can be used by a deriver.
*/
public function __construct(string $id, ?TranslatableMarkup $label = NULL, ?TranslatableMarkup $category = NULL, ?TranslatableMarkup $description = NULL, ?string $template = NULL, string $theme_hook = 'layout', ?string $path = NULL, ?string $library = NULL, ?string $icon = NULL, ?array $icon_map = NULL, array $regions = [], ?string $default_region = NULL, string $class = LayoutDefault::class, array $context_definitions = [], array $config_dependencies = [], ?string $deriver = NULL, ...$additional) {
// Layout definitions support arbitrary properties being passed in, which
// are stored in the 'additional' property in LayoutDefinition. The variadic
// 'additional' parameter here saves arbitrary parameters passed into the
// 'additional' property in this attribute class. The 'additional' property
// gets passed to the LayoutDefinition constructor in ::get().
// @see \Drupal\Core\Layout\LayoutDefinition::$additional
// @see \Drupal\Core\Layout\LayoutDefinition::get()
$this->additional = $additional;
}
/**
* {@inheritdoc}
*/
public function get() : LayoutDefinition {
return new LayoutDefinition(parent::get());
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
AttributeBase::$class | protected | property | The class used for this attribute class. | ||
AttributeBase::$provider | protected | property | The provider of the attribute class. | ||
AttributeBase::getClass | public | function | Overrides AttributeInterface::getClass | 1 | |
AttributeBase::getId | public | function | Overrides AttributeInterface::getId | ||
AttributeBase::getProvider | public | function | Overrides AttributeInterface::getProvider | ||
AttributeBase::setClass | public | function | Overrides AttributeInterface::setClass | 1 | |
AttributeBase::setProvider | public | function | Overrides AttributeInterface::setProvider | ||
Layout::$additional | public | property | Any additional properties and values. | ||
Layout::get | public | function | Overrides AttributeBase::get | ||
Layout::__construct | public | function | Constructs a Layout attribute. | Overrides Plugin::__construct |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.