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
  2. 10 core/modules/layout_builder/src/Plugin/Layout/BlankLayout.php \Drupal\layout_builder\Plugin\Layout\BlankLayout
  3. 9 core/modules/layout_builder/src/Plugin/Layout/BlankLayout.php \Drupal\layout_builder\Plugin\Layout\BlankLayout
  4. 8.9.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.

Attributes

#[Layout(id: 'layout_builder_blank', label: new TranslatableMarkup('Blank Layout'), category: new TranslatableMarkup('Blank Layout'))]

Hierarchy

  • class \Drupal\layout_builder\Plugin\Layout\BlankLayout extends \Drupal\Core\Layout\LayoutDefault

Expanded class hierarchy of BlankLayout

See also

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

\Drupal\layout_builder\SectionListTrait::addBlankSection()

\Drupal\layout_builder\SectionListTrait::hasBlankSection()

File

View on git.drupalcode.org

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 Modifiers Object type Summary Overriden Title Overrides
AutowiredInstanceTrait::createInstanceAutowired public static function Instantiates a new instance of the implementing class using autowiring.
AutowiredInstanceTrait::getAutowireArguments private static function Resolves arguments for a method using autowiring.
BlankLayout::build public function Overrides LayoutDefault::build
ConfigurablePluginBase::__construct public function Overrides PluginBase::__construct 5
ConfigurableTrait::$configuration protected property Configuration information passed into the plugin.
ConfigurableTrait::getConfiguration public function Gets this plugin's configuration. 3
ConfigurableTrait::setConfiguration public function Sets the configuration for this plugin instance. 2
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 9
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
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 2
DependencySerializationTrait::__wakeup public function 2
LayoutDefault::$inPreview protected property Whether the plugin is being rendered in preview mode.
LayoutDefault::$pluginDefinition protected property The layout definition. Overrides PluginBase::$pluginDefinition
LayoutDefault::buildConfigurationForm public function Overrides PluginFormInterface::buildConfigurationForm 3
LayoutDefault::calculateDependencies public function Overrides DependentPluginInterface::calculateDependencies 1
LayoutDefault::defaultConfiguration public function Overrides ConfigurableTrait::defaultConfiguration 3
LayoutDefault::getPluginDefinition public function Overrides ContextAwarePluginTrait::getPluginDefinition
LayoutDefault::setInPreview public function Overrides PreviewAwarePluginInterface::setInPreview
LayoutDefault::submitConfigurationForm public function Overrides PluginFormInterface::submitConfigurationForm 3
LayoutDefault::validateConfigurationForm public function Overrides PluginFormInterface::validateConfigurationForm 1
MessengerTrait::$messenger protected property The messenger. 25
MessengerTrait::messenger public function Gets the messenger. 25
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$pluginId protected property The plugin ID.
PluginBase::create public static function Instantiates a new instance of the implementing class using autowiring. 64
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginId public function Gets the plugin ID of the plugin instance. Overrides PluginInspectionInterface::getPluginId
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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. 2

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