You are here

class UserReference in Drupal 9

Same name in this branch
  1. 9 core/modules/migrate_drupal/src/Plugin/migrate/field/d6/UserReference.php \Drupal\migrate_drupal\Plugin\migrate\field\d6\UserReference
  2. 9 core/modules/migrate_drupal/src/Plugin/migrate/field/d7/UserReference.php \Drupal\migrate_drupal\Plugin\migrate\field\d7\UserReference

MigrateField plugin for Drupal 7 user_reference fields.

Plugin annotation

  id = "user_reference",
  type_map = {
    "user_reference" = "entity_reference",
  core = {7},
  source_module = "user_reference",
  destination_module = "core"


Expanded class hierarchy of UserReference


core/modules/migrate_drupal/src/Plugin/migrate/field/d7/UserReference.php, line 21


View source
class UserReference extends ReferenceBase {

   * The plugin ID for the reference type migration.
   * @var string
  protected $userTypeMigration = 'd7_user_role';

   * {@inheritdoc}
  protected function getEntityTypeMigrationId() {
    return $this->userTypeMigration;

   * {@inheritdoc}
  protected function entityId() {
    return 'uid';

   * {@inheritdoc}
  public function getFieldFormatterMap() {
    return [
      'user_reference_default' => 'entity_reference_label',
      'user_reference_plain' => 'entity_reference_label',
      'user_reference_uid' => 'entity_reference_entity_id',
      'user_reference_user' => 'entity_reference_entity_view',
      'user_reference_path' => 'entity_reference_label',

   * {@inheritdoc}
  public function defineValueProcessPipeline(MigrationInterface $migration, $field_name, $data) {
    $process = [
      'plugin' => 'sub_process',
      'source' => $field_name,
      'process' => [
        'target_id' => [
          'plugin' => 'migration_lookup',
          'migration' => 'd7_user',
          'source' => 'uid',
      ->setProcessOfProperty($field_name, $process);



Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FieldPluginBase::alterFieldFormatterMigration public function Apply any custom processing to the field formatter migration. Overrides MigrateFieldInterface::alterFieldFormatterMigration
FieldPluginBase::alterFieldMigration public function Apply any custom processing to the field migration. Overrides MigrateFieldInterface::alterFieldMigration
FieldPluginBase::alterFieldWidgetMigration public function Apply any custom processing to the field widget migration. Overrides MigrateFieldInterface::alterFieldWidgetMigration
FieldPluginBase::getFieldFormatterType public function Get the field formatter type from the source. Overrides MigrateFieldInterface::getFieldFormatterType 1
FieldPluginBase::getFieldType public function Computes the destination type of a migrated field. Overrides MigrateFieldInterface::getFieldType 3
FieldPluginBase::getFieldWidgetType public function Get the field widget type from the source. Overrides MigrateFieldInterface::getFieldWidgetType 1
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.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 98
ReferenceBase::alterFieldInstanceMigration public function Apply any custom processing to the field instance migration. Overrides FieldPluginBase::alterFieldInstanceMigration
ReferenceBase::getFieldWidgetMap public function Get a map between D6 and D8 widgets for this field type. Overrides FieldPluginBase::getFieldWidgetMap
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.
UserReference::$userTypeMigration protected property The plugin ID for the reference type migration.
UserReference::defineValueProcessPipeline public function Apply any custom processing to the field bundle migrations. Overrides ReferenceBase::defineValueProcessPipeline
UserReference::entityId protected function Gets the name of the field property which holds the entity ID. Overrides ReferenceBase::entityId
UserReference::getEntityTypeMigrationId protected function Gets the plugin ID for the reference type migration. Overrides ReferenceBase::getEntityTypeMigrationId
UserReference::getFieldFormatterMap public function Get a map between D6 formatters and D8 formatters for this field type. Overrides FieldPluginBase::getFieldFormatterMap