class PerComponentEntityFormDisplay

This class imports one component of an entity form display.

Destination properties expected in the imported row:

• entity_type: The entity type ID.
• bundle: The entity bundle.
• form_mode: The machine name of the form mode.
• field_name: The machine name of the field to be imported into the display.
• options: (optional) An array of options for displaying the field in this form mode.

Examples:

source:
  constants:
    entity_type: node
    field_name: comment
    form_mode: default
    options:
      type: comment_default
      weight: 20
process:
  entity_type: 'constants/entity_type'
  field_name: 'constants/field_name'
  form_mode: 'constants/form_mode'
  options: 'constants/options'
  bundle: node_type
destination:
  plugin: component_entity_form_display

This will add a "comment" field on the "default" form mode of the "node" entity type with options defined by the "options" constant.

Plugin annotation

@MigrateDestination(
  id = "component_entity_form_display"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase extends \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 implements \Drupal\Component\Plugin\PluginBase
    • class \Drupal\migrate\Plugin\migrate\destination\DestinationBase extends \Drupal\migrate\Plugin\MigrateDestinationInterface, \Drupal\migrate\Plugin\RequirementsInterface implements \Drupal\Core\Plugin\PluginBase
      • class \Drupal\migrate\Plugin\migrate\destination\ComponentEntityDisplayBase extends \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\migrate\Plugin\migrate\destination\DestinationBase
        • class \Drupal\migrate\Plugin\migrate\destination\PerComponentEntityFormDisplay implements \Drupal\migrate\Plugin\migrate\destination\ComponentEntityDisplayBase

Expanded class hierarchy of PerComponentEntityFormDisplay

File

core/modules/migrate/src/Plugin/migrate/destination/PerComponentEntityFormDisplay.php, line 44

Namespace

class PerComponentEntityFormDisplay extends ComponentEntityDisplayBase {
  const MODE_NAME = 'form_mode';
  
  /**
   * {@inheritdoc}
   */
  protected function getEntity($entity_type, $bundle, $form_mode) {
    return $this->entityDisplayRepository
      ->getFormDisplay($entity_type, $bundle, $form_mode);
  }

}