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. 8.9.x 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.

Hierarchy

Expanded class hierarchy of BlankLayout

See also

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

\Drupal\layout_builder\SectionListTrait::addBlankSection()

\Drupal\layout_builder\SectionListTrait::hasBlankSection()

File

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

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
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginAssignmentTrait::t abstract protected function Ensures the t() method is available.
ContextAwarePluginTrait::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginTrait::getCacheContexts public function 10
ContextAwarePluginTrait::getCacheMaxAge public function 6
ContextAwarePluginTrait::getCacheTags public function 3
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function 1
ContextAwarePluginTrait::getContexts public function
ContextAwarePluginTrait::getContextValue public function
ContextAwarePluginTrait::getContextValues public function
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContextMapping public function
ContextAwarePluginTrait::setContextValue public function
ContextAwarePluginTrait::validateContexts public function
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::$inPreview protected property Whether the plugin is being rendered in preview mode.
LayoutDefault::$pluginDefinition protected property The layout definition.
LayoutDefault::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 3
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 4
LayoutDefault::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
LayoutDefault::getPluginDefinition public function Overrides ContextAwarePluginTrait::getPluginDefinition
LayoutDefault::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
LayoutDefault::setInPreview public function Set preview mode for the plugin. Overrides PreviewAwarePluginInterface::setInPreview
LayoutDefault::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm 3
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.