class EntityUser
Provides a destination plugin for migrating user entities.
Example:
The example below migrates users and preserves original passwords from a source that has passwords as MD5 hashes without salt. The passwords will be salted and re-hashed before they are saved to the destination Drupal database. The MD5 hash used in the example is a hash of 'password'.
The example uses the EmbeddedDataSource source plugin for the sake of simplicity. The mapping between old user_ids and new Drupal uids is saved in the migration map table.
id: custom_user_migration
label: Custom user migration
source:
  plugin: embedded_data
  data_rows:
    -
      user_id: 1
      name: JohnSmith
      mail: johnsmith@example.com
      hash: '5f4dcc3b5aa765d61d8327deb882cf99'
  ids:
    user_id:
      type: integer
process:
  name: name
  mail: mail
  pass: hash
  status:
    plugin: default_value
    default_value: 1
destination:
  plugin: entity:user
  md5_passwords: true
For configuration options inherited from the parent class, refer to \Drupal\migrate\Plugin\migrate\destination\EntityContentBase.
The example above is about migrating an MD5 password hash. For more examples on different password hash types and a list of other user properties, refer to the handbook documentation:
Plugin annotation
@MigrateDestination(
  id = "entity:user"
)
  
  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\migrate\Plugin\migrate\destination\DestinationBase implements \Drupal\migrate\Plugin\MigrateDestinationInterface, \Drupal\migrate\Plugin\RequirementsInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\migrate\Plugin\migrate\destination\Entity implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface uses \Drupal\Core\Entity\DependencyTrait, \Drupal\migrate\EntityFieldDefinitionTrait extends \Drupal\migrate\Plugin\migrate\destination\DestinationBase
- class \Drupal\migrate\Plugin\migrate\destination\EntityContentBase implements \Drupal\migrate\Audit\HighestIdInterface, \Drupal\migrate\Plugin\MigrateValidatableEntityInterface extends \Drupal\migrate\Plugin\migrate\destination\Entity
- class \Drupal\user\Plugin\migrate\destination\EntityUser extends \Drupal\migrate\Plugin\migrate\destination\EntityContentBase
 
 
 - class \Drupal\migrate\Plugin\migrate\destination\EntityContentBase implements \Drupal\migrate\Audit\HighestIdInterface, \Drupal\migrate\Plugin\MigrateValidatableEntityInterface extends \Drupal\migrate\Plugin\migrate\destination\Entity
 
 - class \Drupal\migrate\Plugin\migrate\destination\Entity implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface uses \Drupal\Core\Entity\DependencyTrait, \Drupal\migrate\EntityFieldDefinitionTrait extends \Drupal\migrate\Plugin\migrate\destination\DestinationBase
 
 - class \Drupal\migrate\Plugin\migrate\destination\DestinationBase implements \Drupal\migrate\Plugin\MigrateDestinationInterface, \Drupal\migrate\Plugin\RequirementsInterface 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 EntityUser
See also
https://www.drupal.org/docs/8/api/migrate-api/migrate-destination-plugiā¦
File
- 
              core/
modules/ user/ src/ Plugin/ migrate/ destination/ EntityUser.php, line 69  
Namespace
Drupal\user\Plugin\migrate\destinationView source
class EntityUser extends EntityContentBase {
  
  /**
   * The password service class.
   *
   * @var \Drupal\Core\Password\PasswordInterface
   */
  protected $password;
  
  /**
   * Builds a user entity destination.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\migrate\Plugin\MigrationInterface $migration
   *   The migration.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   The storage for this entity type.
   * @param array $bundles
   *   The list of bundles this entity type has.
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
   *   The entity field manager.
   * @param \Drupal\Core\Field\FieldTypePluginManagerInterface $field_type_manager
   *   The field type plugin manager service.
   * @param \Drupal\Core\Password\PasswordInterface $password
   *   The password service.
   * @param \Drupal\Core\Session\AccountSwitcherInterface|null $account_switcher
   *   The account switcher service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, EntityStorageInterface $storage, array $bundles, EntityFieldManagerInterface $entity_field_manager, FieldTypePluginManagerInterface $field_type_manager, PasswordInterface $password, AccountSwitcherInterface $account_switcher = NULL) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $migration, $storage, $bundles, $entity_field_manager, $field_type_manager, $account_switcher);
    $this->password = $password;
  }
  
  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration = NULL) {
    $entity_type = static::getEntityTypeId($plugin_id);
    return new static($configuration, $plugin_id, $plugin_definition, $migration, $container->get('entity_type.manager')
      ->getStorage($entity_type), array_keys($container->get('entity_type.bundle.info')
      ->getBundleInfo($entity_type)), $container->get('entity_field.manager'), $container->get('plugin.manager.field.field_type'), $container->get('password'), $container->get('account_switcher'));
  }
  
  /**
   * {@inheritdoc}
   * @throws \Drupal\migrate\MigrateException
   */
  public function import(Row $row, array $old_destination_id_values = []) {
    // Do not overwrite the root account password.
    if ($row->getDestinationProperty('uid') == 1) {
      $row->removeDestinationProperty('pass');
    }
    return parent::import($row, $old_destination_id_values);
  }
  
  /**
   * {@inheritdoc}
   */
  protected function save(ContentEntityInterface $entity, array $old_destination_id_values = []) {
    // Do not overwrite the root account password.
    if ($entity->id() != 1) {
      // Set the pre_hashed password so that the PasswordItem field does not hash
      // already hashed passwords. If the md5_passwords configuration option is
      // set we need to rehash the password and prefix with a U.
      // @see \Drupal\Core\Field\Plugin\Field\FieldType\PasswordItem::preSave()
      $entity->pass->pre_hashed = TRUE;
      if (isset($this->configuration['md5_passwords'])) {
        $entity->pass->value = 'U' . $this->password
          ->hash($entity->pass->value);
      }
    }
    return parent::save($entity, $old_destination_id_values);
  }
  
  /**
   * {@inheritdoc}
   */
  protected function processStubRow(Row $row) {
    parent::processStubRow($row);
    // Email address is not defined as required in the base field definition but
    // is effectively required by the UserMailRequired constraint. This means
    // that Entity::processStubRow() did not populate it - we do it here.
    $field_definitions = $this->entityFieldManager
      ->getFieldDefinitions($this->storage
      ->getEntityTypeId(), $this->getKey('bundle'));
    $mail = EmailItem::generateSampleValue($field_definitions['mail']);
    $row->setDestinationProperty('mail', reset($mail));
    // @todo Work-around for https://www.drupal.org/node/2602066.
    $name = $row->getDestinationProperty('name');
    if (is_array($name)) {
      $name = reset($name);
    }
    if (mb_strlen($name) > UserInterface::USERNAME_MAX_LENGTH) {
      $row->setDestinationProperty('name', mb_substr($name, 0, UserInterface::USERNAME_MAX_LENGTH));
    }
  }
  
  /**
   * {@inheritdoc}
   */
  public function getHighestId() {
    $highest_id = parent::getHighestId();
    // Every Drupal site must have a user with UID of 1 and it's normal for
    // migrations to overwrite this user.
    if ($highest_id === 1) {
      return 0;
    }
    return $highest_id;
  }
}
Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides | 
|---|---|---|---|---|---|
| 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 | #[\ReturnTypeWillChange] | 2 | |
| DependencyTrait::$dependencies | protected | property | The object's dependencies. | ||
| DependencyTrait::addDependencies | protected | function | Adds multiple dependencies. | ||
| DependencyTrait::addDependency | protected | function | Adds a dependency. | ||
| DestinationBase::$migration | protected | property | The migration. | ||
| DestinationBase::$rollbackAction | protected | property | The rollback action to be saved for the last imported item. | ||
| DestinationBase::$supportsRollback | protected | property | Indicates whether the destination can be rolled back. | ||
| DestinationBase::checkRequirements | public | function | Checks if requirements for this plugin are OK. | Overrides RequirementsInterface::checkRequirements | |
| DestinationBase::getDestinationModule | public | function | Gets the destination module handling the destination data. | Overrides MigrateDestinationInterface::getDestinationModule | 1 | 
| DestinationBase::rollbackAction | public | function | The rollback action for the last imported item. | Overrides MigrateDestinationInterface::rollbackAction | |
| DestinationBase::setRollbackAction | protected | function | For a destination item being updated, set the appropriate rollback action. | ||
| DestinationBase::supportsRollback | public | function | Whether the destination can be rolled back or not. | Overrides MigrateDestinationInterface::supportsRollback | |
| Entity::$bundles | protected | property | The list of the bundles of this entity type. | ||
| Entity::$entityFieldManager | protected | property | The entity field manager. | ||
| Entity::$storage | protected | property | The entity storage. | ||
| Entity::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides DependentPluginInterface::calculateDependencies | |
| Entity::fields | public | function | Returns an array of destination fields. | Overrides MigrateDestinationInterface::fields | |
| Entity::getBundle | public | function | Gets the bundle for the row taking into account the default. | ||
| Entity::getEntity | protected | function | Creates or loads an entity. | 5 | |
| Entity::getEntityId | protected | function | Gets the entity ID of the row. | 2 | |
| Entity::getKey | protected | function | Returns a specific entity key. | ||
| EntityContentBase::$accountSwitcher | protected | property | The account switcher service. | ||
| EntityContentBase::$fieldTypeManager | protected | property | Field type plugin manager. | ||
| EntityContentBase::getIds | public | function | Gets the destination IDs. | Overrides MigrateDestinationInterface::getIds | 2 | 
| EntityContentBase::isEntityValidationRequired | public | function | Returns a state of whether an entity needs to be validated before saving. | Overrides MigrateValidatableEntityInterface::isEntityValidationRequired | |
| EntityContentBase::isTranslationDestination | public | function | |||
| EntityContentBase::rollback | public | function | Delete the specified destination object from the target Drupal. | Overrides Entity::rollback | 1 | 
| EntityContentBase::updateEntity | protected | function | Updates an entity with the new values from row. | 3 | |
| EntityContentBase::validateEntity | public | function | Validates the entity. | Overrides MigrateValidatableEntityInterface::validateEntity | |
| EntityFieldDefinitionTrait::getDefinitionFromEntity | protected | function | Gets the field definition from a specific entity base field. | ||
| EntityFieldDefinitionTrait::getEntityTypeId | protected static | function | Finds the entity type from configuration or plugin ID. | 3 | |
| EntityUser::$password | protected | property | The password service class. | ||
| EntityUser::create | public static | function | Creates an instance of the plugin. | Overrides EntityContentBase::create | |
| EntityUser::getHighestId | public | function | Returns the highest ID tracked by the implementing plugin. | Overrides EntityContentBase::getHighestId | |
| EntityUser::import | public | function | Overrides EntityContentBase::import | ||
| EntityUser::processStubRow | protected | function | Populates as much of the stub row as possible. | Overrides EntityContentBase::processStubRow | |
| EntityUser::save | protected | function | Saves the entity. | Overrides EntityContentBase::save | |
| EntityUser::__construct | public | function | Builds a user entity destination. | Overrides EntityContentBase::__construct | |
| MessengerTrait::$messenger | protected | property | The messenger. | 27 | |
| MessengerTrait::messenger | public | function | Gets the messenger. | 27 | |
| 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 | 2 | 
| 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. | ||
| 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 | |
| StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.