interface LayoutPluginManagerInterface

Same name in other branches
  1. 9 core/lib/Drupal/Core/Layout/LayoutPluginManagerInterface.php \Drupal\Core\Layout\LayoutPluginManagerInterface
  2. 8.9.x core/lib/Drupal/Core/Layout/LayoutPluginManagerInterface.php \Drupal\Core\Layout\LayoutPluginManagerInterface
  3. 11.x core/lib/Drupal/Core/Layout/LayoutPluginManagerInterface.php \Drupal\Core\Layout\LayoutPluginManagerInterface

Provides the interface for a plugin manager of layouts.

Hierarchy

Expanded class hierarchy of LayoutPluginManagerInterface

All classes that implement LayoutPluginManagerInterface

8 files declare their use of LayoutPluginManagerInterface
ChooseSectionController.php in core/modules/layout_builder/src/Controller/ChooseSectionController.php
FieldLayoutBuilder.php in core/modules/field_layout/src/FieldLayoutBuilder.php
FieldLayoutBuilderTest.php in core/modules/field_layout/tests/src/Unit/FieldLayoutBuilderTest.php
FieldLayoutEntityFormDisplayEditForm.php in core/modules/field_layout/src/Form/FieldLayoutEntityFormDisplayEditForm.php
FieldLayoutEntityViewDisplayEditForm.php in core/modules/field_layout/src/Form/FieldLayoutEntityViewDisplayEditForm.php

... See full list

File

core/lib/Drupal/Core/Layout/LayoutPluginManagerInterface.php, line 11

Namespace

Drupal\Core\Layout
View source
interface LayoutPluginManagerInterface extends CategorizingPluginManagerInterface, FilteredPluginManagerInterface {
    
    /**
     * Gets theme implementations for layouts.
     *
     * @return array
     *   An associative array of the same format as returned by hook_theme().
     *
     * @see hook_theme()
     */
    public function getThemeImplementations();
    
    /**
     * {@inheritdoc}
     *
     * @return \Drupal\Core\Layout\LayoutInterface
     */
    public function createInstance($plugin_id, array $configuration = []);
    
    /**
     * {@inheritdoc}
     *
     * @return \Drupal\Core\Layout\LayoutDefinition|null
     */
    public function getDefinition($plugin_id, $exception_on_invalid = TRUE);
    
    /**
     * {@inheritdoc}
     *
     * @return \Drupal\Core\Layout\LayoutDefinition[]
     */
    public function getDefinitions();
    
    /**
     * {@inheritdoc}
     *
     * @return \Drupal\Core\Layout\LayoutDefinition[]
     */
    public function getSortedDefinitions(?array $definitions = NULL);
    
    /**
     * {@inheritdoc}
     *
     * @return \Drupal\Core\Layout\LayoutDefinition[][]
     */
    public function getGroupedDefinitions(?array $definitions = NULL);
    
    /**
     * Returns an array of layout labels grouped by category.
     *
     * @return string[][]
     *   A nested array of labels suitable for #options.
     */
    public function getLayoutOptions();

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
CategorizingPluginManagerInterface::getCategories public function Gets the names of all categories.
FilteredPluginManagerInterface::getFilteredDefinitions public function Gets the plugin definitions for a given type and consumer and filters them.
LayoutPluginManagerInterface::createInstance public function
LayoutPluginManagerInterface::getDefinition public function
LayoutPluginManagerInterface::getDefinitions public function
LayoutPluginManagerInterface::getGroupedDefinitions public function Overrides CategorizingPluginManagerInterface::getGroupedDefinitions
LayoutPluginManagerInterface::getLayoutOptions public function Returns an array of layout labels grouped by category.
LayoutPluginManagerInterface::getSortedDefinitions public function Overrides CategorizingPluginManagerInterface::getSortedDefinitions
LayoutPluginManagerInterface::getThemeImplementations public function Gets theme implementations for layouts.

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