function UserData::fields

Same name and namespace in other branches
  1. 9 core/modules/user/src/Plugin/migrate/destination/UserData.php \Drupal\user\Plugin\migrate\destination\UserData::fields()
  2. 8.9.x core/modules/user/src/Plugin/migrate/destination/UserData.php \Drupal\user\Plugin\migrate\destination\UserData::fields()
  3. 11.x core/modules/user/src/Plugin/migrate/destination/UserData.php \Drupal\user\Plugin\migrate\destination\UserData::fields()

Returns an array of destination fields.

Derived classes must implement fields(), returning a list of available destination fields.

Return value

array

  • Keys: machine names of the fields
  • Values: Human-friendly descriptions of the fields.

Overrides MigrateDestinationInterface::fields

File

core/modules/user/src/Plugin/migrate/destination/UserData.php, line 81

Class

UserData
Migration destination for user data.

Namespace

Drupal\user\Plugin\migrate\destination

Code

public function fields() {
    return [
        'uid' => 'The user id.',
        'module' => 'The module name responsible for the settings.',
        'key' => 'The setting key to save under.',
        'settings' => 'The settings to save.',
    ];
}

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