class LayoutBuilderWidget
A widget to display the layout form.
@FieldWidget( id = "layout_builder_widget", label = @Translation("Layout Builder Widget"), description = @Translation("A field widget for Layout Builder."), field_types = { "layout_section", }, multiple_values = TRUE, )
@internal Plugin classes are internal.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Field\PluginSettingsBase implements \Drupal\Core\Field\PluginSettingsInterface, \Drupal\Component\Plugin\DependentPluginInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Field\WidgetBase implements \Drupal\Core\Field\WidgetInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface uses \Drupal\Core\Field\AllowedTagsXssTrait extends \Drupal\Core\Field\PluginSettingsBase
- class \Drupal\layout_builder\Plugin\Field\FieldWidget\LayoutBuilderWidget extends \Drupal\Core\Field\WidgetBase
 
 
 - class \Drupal\Core\Field\WidgetBase implements \Drupal\Core\Field\WidgetInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface uses \Drupal\Core\Field\AllowedTagsXssTrait extends \Drupal\Core\Field\PluginSettingsBase
 
 - class \Drupal\Core\Field\PluginSettingsBase implements \Drupal\Core\Field\PluginSettingsInterface, \Drupal\Component\Plugin\DependentPluginInterface extends \Drupal\Core\Plugin\PluginBase
 
 - class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
 
Expanded class hierarchy of LayoutBuilderWidget
File
- 
              core/
modules/ layout_builder/ src/ Plugin/ Field/ FieldWidget/ LayoutBuilderWidget.php, line 25  
Namespace
Drupal\layout_builder\Plugin\Field\FieldWidgetView source
class LayoutBuilderWidget extends WidgetBase {
  
  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $element += [
      '#type' => 'layout_builder',
      '#section_storage' => $this->getSectionStorage($form_state),
    ];
    $element['#process'][] = [
      static::class,
      'layoutBuilderElementGetKeys',
    ];
    return $element;
  }
  
  /**
   * Form element #process callback.
   *
   * Save the layout builder element array parents as a property on the top form
   * element so that they can be used to access the element within the whole
   * render array later.
   *
   * @see \Drupal\layout_builder\Controller\LayoutBuilderHtmlEntityFormController
   */
  public static function layoutBuilderElementGetKeys(array $element, FormStateInterface $form_state, &$form) {
    $form['#layout_builder_element_keys'] = $element['#array_parents'];
    return $element;
  }
  
  /**
   * {@inheritdoc}
   */
  public function extractFormValues(FieldItemListInterface $items, array $form, FormStateInterface $form_state) {
    // @todo This isn't resilient to being set twice, during validation and
    //   save https://www.drupal.org/project/drupal/issues/2833682.
    if (!$form_state->isValidationComplete()) {
      return;
    }
    $items->setValue($this->getSectionStorage($form_state)
      ->getSections());
  }
  
  /**
   * Gets the section storage.
   *
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state.
   *
   * @return \Drupal\layout_builder\SectionStorageInterface
   *   The section storage loaded from the tempstore.
   */
  private function getSectionStorage(FormStateInterface $form_state) {
    return $form_state->getFormObject()
      ->getSectionStorage();
  }
}
Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides | 
|---|---|---|---|---|---|
| AllowedTagsXssTrait::allowedTags | public | function | Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss(). | ||
| AllowedTagsXssTrait::displayAllowedTags | public | function | Returns a human-readable list of allowed tags for display in help texts. | ||
| AllowedTagsXssTrait::fieldFilterXss | public | function | Filters an HTML string to prevent XSS vulnerabilities. | ||
| 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 | 1 | ||
| DependencySerializationTrait::__wakeup | public | function | 2 | ||
| LayoutBuilderWidget::extractFormValues | public | function | Extracts field values from submitted form values. | Overrides WidgetBase::extractFormValues | |
| LayoutBuilderWidget::formElement | public | function | Returns the form for a single field widget. | Overrides WidgetInterface::formElement | |
| LayoutBuilderWidget::getSectionStorage | private | function | Gets the section storage. | ||
| LayoutBuilderWidget::layoutBuilderElementGetKeys | public static | function | Form element #process callback. | ||
| MessengerTrait::$messenger | protected | property | The messenger. | 29 | |
| MessengerTrait::messenger | public | function | Gets the messenger. | 29 | |
| MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
| PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | |
| PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | |
| 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 | 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::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | Overrides PluginInspectionInterface::getPluginDefinition | 3 | 
| PluginBase::getPluginId | public | function | Gets the plugin_id of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | |
| PluginBase::isConfigurable | public | function | Determines if the plugin is configurable. | ||
| PluginSettingsBase::$defaultSettingsMerged | protected | property | Whether default settings have been merged into the current $settings. | ||
| PluginSettingsBase::$thirdPartySettings | protected | property | The plugin settings injected by third party modules. | ||
| PluginSettingsBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides DependentPluginInterface::calculateDependencies | 6 | 
| PluginSettingsBase::defaultSettings | public static | function | Defines the default settings for this plugin. | Overrides PluginSettingsInterface::defaultSettings | 42 | 
| PluginSettingsBase::getSetting | public | function | Returns the value of a setting, or its default value if absent. | Overrides PluginSettingsInterface::getSetting | |
| PluginSettingsBase::getSettings | public | function | Returns the array of settings, including defaults for missing settings. | Overrides PluginSettingsInterface::getSettings | |
| PluginSettingsBase::getThirdPartyProviders | public | function | Gets the list of third parties that store information. | Overrides ThirdPartySettingsInterface::getThirdPartyProviders | |
| PluginSettingsBase::getThirdPartySetting | public | function | Gets the value of a third-party setting. | Overrides ThirdPartySettingsInterface::getThirdPartySetting | |
| PluginSettingsBase::getThirdPartySettings | public | function | Gets all third-party settings of a given module. | Overrides ThirdPartySettingsInterface::getThirdPartySettings | |
| PluginSettingsBase::mergeDefaults | protected | function | Merges default settings values into $settings. | ||
| PluginSettingsBase::onDependencyRemoval | public | function | Informs the plugin that some configuration it depends on will be deleted. | Overrides PluginSettingsInterface::onDependencyRemoval | 3 | 
| PluginSettingsBase::setSetting | public | function | Sets the value of a setting for the plugin. | Overrides PluginSettingsInterface::setSetting | |
| PluginSettingsBase::setSettings | public | function | Sets the settings for the plugin. | Overrides PluginSettingsInterface::setSettings | |
| PluginSettingsBase::setThirdPartySetting | public | function | Sets the value of a third-party setting. | Overrides ThirdPartySettingsInterface::setThirdPartySetting | |
| PluginSettingsBase::unsetThirdPartySetting | public | function | Unsets a third-party setting. | Overrides ThirdPartySettingsInterface::unsetThirdPartySetting | |
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 1 | |
| 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 | |
| StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | ||
| WidgetBase::$fieldDefinition | protected | property | The field definition. | ||
| WidgetBase::$settings | protected | property | The widget settings. | Overrides PluginSettingsBase::$settings | |
| WidgetBase::addMoreAjax | public static | function | Ajax callback for the "Add another item" button. | ||
| WidgetBase::addMoreSubmit | public static | function | Submission handler for the "Add another item" button. | ||
| WidgetBase::afterBuild | public static | function | After-build handler for field elements in a form. | ||
| WidgetBase::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | 5 | 
| WidgetBase::errorElement | public | function | Assigns a field-level validation error to the right widget sub-element. | Overrides WidgetInterface::errorElement | 8 | 
| WidgetBase::flagErrors | public | function | Reports field-level validation errors against actual form elements. | Overrides WidgetBaseInterface::flagErrors | 2 | 
| WidgetBase::form | public | function | Creates a form element for a field. | Overrides WidgetBaseInterface::form | 3 | 
| WidgetBase::formMultipleElements | protected | function | Special handling to create form elements for multiple values. | 1 | |
| WidgetBase::formSingleElement | protected | function | Generates the form element for a single copy of the widget. | ||
| WidgetBase::getFieldSetting | protected | function | Returns the value of a field setting. | ||
| WidgetBase::getFieldSettings | protected | function | Returns the array of field settings. | ||
| WidgetBase::getFilteredDescription | protected | function | Returns the filtered field description. | ||
| WidgetBase::getWidgetState | public static | function | Retrieves processing information about the widget from $form_state. | Overrides WidgetBaseInterface::getWidgetState | |
| WidgetBase::getWidgetStateParents | protected static | function | Returns the location of processing information within $form_state. | ||
| WidgetBase::handlesMultipleValues | protected | function | Returns whether the widget handles multiple values. | ||
| WidgetBase::isApplicable | public static | function | Returns if the widget can be used for the provided field. | Overrides WidgetInterface::isApplicable | 4 | 
| WidgetBase::isDefaultValueWidget | protected | function | Returns whether the widget used for default value form. | ||
| WidgetBase::massageFormValues | public | function | Massages the form values into the format expected for field values. | Overrides WidgetInterface::massageFormValues | 7 | 
| WidgetBase::settingsForm | public | function | Returns a form to configure settings for the widget. | Overrides WidgetInterface::settingsForm | 16 | 
| WidgetBase::settingsSummary | public | function | Returns a short summary for the current widget settings. | Overrides WidgetInterface::settingsSummary | 15 | 
| WidgetBase::setWidgetState | public static | function | Stores processing information about the widget in $form_state. | Overrides WidgetBaseInterface::setWidgetState | |
| WidgetBase::__construct | public | function | Constructs a WidgetBase object. | Overrides PluginBase::__construct | 5 | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.