class BlankLayout

Same name in other branches
  1. 9 core/modules/layout_builder/src/Plugin/Layout/BlankLayout.php \Drupal\layout_builder\Plugin\Layout\BlankLayout
  2. 10 core/modules/layout_builder/src/Plugin/Layout/BlankLayout.php \Drupal\layout_builder\Plugin\Layout\BlankLayout
  3. 11.x core/modules/layout_builder/src/Plugin/Layout/BlankLayout.php \Drupal\layout_builder\Plugin\Layout\BlankLayout

Provides a layout plugin that produces no output.

@internal This layout plugin is intended for internal use by Layout Builder only.

Plugin annotation


@Layout(
  id = "layout_builder_blank",
)

Hierarchy

Expanded class hierarchy of BlankLayout

See also

\Drupal\layout_builder\Field\LayoutSectionItemList::removeSection()

\Drupal\layout_builder\SectionStorage\SectionStorageTrait::addBlankSection()

\Drupal\layout_builder\SectionStorage\SectionStorageTrait::hasBlankSection()

File

core/modules/layout_builder/src/Plugin/Layout/BlankLayout.php, line 21

Namespace

Drupal\layout_builder\Plugin\Layout
View source
class BlankLayout extends LayoutDefault {
    
    /**
     * {@inheritdoc}
     */
    public function build(array $regions) {
        // Return no output.
        return [];
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
BlankLayout::build public function Build a render array for layout with regions. Overrides LayoutDefault::build
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
LayoutDefault::$pluginDefinition protected property The layout definition.
LayoutDefault::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 2
LayoutDefault::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 2
LayoutDefault::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 3
LayoutDefault::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
LayoutDefault::getPluginDefinition public function Overrides LayoutInterface::getPluginDefinition
LayoutDefault::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
LayoutDefault::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm 2
LayoutDefault::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 1
LayoutDefault::__construct public function
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2

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