class BlankLayout

Same name and namespace in other branches
  1. 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\SectionListTrait::addBlankSection()

\Drupal\layout_builder\SectionListTrait::hasBlankSection()

File

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

Namespace

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

}

Members

Title 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::$initializedContextConfig protected property Tracks whether the context has been initialized from configuration.
ContextAwarePluginTrait::getCacheContexts public function 1
ContextAwarePluginTrait::getCacheContexts public function 1
ContextAwarePluginTrait::getCacheMaxAge public function 1
ContextAwarePluginTrait::getCacheMaxAge public function 1
ContextAwarePluginTrait::getCacheTags public function
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function
ContextAwarePluginTrait::getContexts public function
ContextAwarePluginTrait::getContextValue public function
ContextAwarePluginTrait::getContextValues public function
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContextMapping public function
ContextAwarePluginTrait::setContextValue public function
ContextAwarePluginTrait::validateContexts public function
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function
DependencySerializationTrait::__wakeup public function #[\ReturnTypeWillChange]
LayoutDefault::$inPreview protected property Whether the plugin is being rendered in preview mode.
LayoutDefault::$pluginDefinition protected property The layout definition.
LayoutDefault::buildConfigurationForm public function 1
LayoutDefault::buildConfigurationForm public function 1
LayoutDefault::calculateDependencies public function
LayoutDefault::defaultConfiguration public function 1
LayoutDefault::defaultConfiguration public function 1
LayoutDefault::getConfiguration public function
LayoutDefault::getPluginDefinition public function
LayoutDefault::setConfiguration public function
LayoutDefault::setInPreview public function
LayoutDefault::submitConfigurationForm public function 1
LayoutDefault::submitConfigurationForm public function 1
LayoutDefault::validateConfigurationForm public function
LayoutDefault::__construct public function
MessengerTrait::$messenger protected property The messenger. 7
MessengerTrait::$messenger protected property The messenger. 7
MessengerTrait::messenger public function Gets the messenger. 7
MessengerTrait::messenger public function Gets the messenger. 7
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function
PluginBase::getDerivativeId public function
PluginBase::getPluginId public function
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service.
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use.

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