{"id":57836,"date":"2023-07-29T09:16:18","date_gmt":"2023-07-29T03:46:18","guid":{"rendered":"https:\/\/www.tothenew.com\/blog\/?p=57836"},"modified":"2023-08-28T09:33:37","modified_gmt":"2023-08-28T04:03:37","slug":"migrating-users-roles-from-drupal-7-to-drupal-10","status":"publish","type":"post","link":"https:\/\/www.tothenew.com\/blog\/migrating-users-roles-from-drupal-7-to-drupal-10\/","title":{"rendered":"Migrating Users & roles from Drupal 7 to Drupal 10"},"content":{"rendered":"

This blog will target the migration of users & roles from the Drupal 7 website to the Drupal 10 website.<\/span><\/p>\n

Why should you migrate from Drupal 7 to Drupal 10?<\/span><\/strong><\/h2>\n

November 2023 will be the end of life for Drupal 7. With the release of Drupal 10, it is essential to migrate the website from outdated versions for better community support, technological advancement, and security.<\/span><\/p>\n

We will start with creating a role migration definition.<\/span><\/p>\n

First step: Create migration definition<\/h1>\n

Add the YAML file in the location \/custom_module\/config\/install\/migrate_plus.migration.d7_user_role.yml:<\/em><\/p>\n

id:<\/span> d7_user_role<\/span>\r\nlabel:<\/span> User<\/span> roles<\/span>\r\nmigration_tags:<\/span>\r\n-<\/span> Drupal<\/span> 7<\/span>\r\n-<\/span> Configuration<\/span>\r\nsource:<\/span>\r\nplugin:<\/span> d7_user_role<\/span>\r\nprocess:<\/span>\r\nid:<\/span>\r\n-<\/span>\r\nplugin:<\/span> machine_name<\/span>\r\nsource:<\/span> name<\/span>\r\n-<\/span>\r\nplugin:<\/span> user_update_8002<\/span>\r\nlabel:<\/span> name<\/span>\r\npermissions:<\/span>\r\n-<\/span>\r\nplugin:<\/span> static_map<\/span>\r\nsource:<\/span> permissions<\/span>\r\nbypass:<\/span> true<\/span>\r\n-<\/span> plugin:<\/span> flatten<\/span>\r\nweight:<\/span> weight<\/span>\r\ndestination:<\/span>\r\nplugin:<\/span> entity:user_role<\/span>\r\nmigration_dependencies:<\/span>\r\noptional:<\/span>\r\n-<\/span> block_content_type<\/span>\r\n-<\/span> contact_category<\/span>\r\n-<\/span> d7_comment_type<\/span>\r\n-<\/span> d7_filter_format<\/span>\r\n-<\/span> d7_node_type<\/span>\r\n-<\/span> d7_shortcut_set<\/span>\r\n-<\/span> d7_taxonomy_vocabulary<\/span>\r\n-<\/span> d7_taxonomy_vocabulary_translation<\/span>\r\n<\/pre>\n
AND
\nAdd YAML file in the location \/custom_module\/config\/install\/migrate_plus.migration.d7_user.yml:<\/em><\/p>\n
id:<\/span> d7_user<\/span>\r\nlabel:<\/span> User<\/span> accounts<\/span>\r\naudit:<\/span> true<\/span>\r\nmigration_tags:<\/span>\r\n-<\/span> Drupal<\/span> 7<\/span>\r\n-<\/span> Content<\/span>\r\nclass:<\/span> Drupal\\user\\Plugin\\migrate\\User<\/span>\r\nsource:<\/span>\r\nplugin:<\/span> d7_user<\/span>\r\nprocess:<\/span>\r\nname:<\/span> name<\/span>\r\npass:<\/span> pass<\/span>\r\nmail:<\/span> mail<\/span>\r\ncreated:<\/span> created<\/span>\r\naccess:<\/span> access<\/span>\r\nlogin:<\/span> login<\/span>\r\nstatus:<\/span> status<\/span>\r\ntimezone:<\/span> timezone<\/span>\r\nlangcode:<\/span>\r\nplugin:<\/span> user_langcode<\/span>\r\nsource:<\/span> entity_language<\/span>\r\nfallback_to_site_default:<\/span> false<\/span>\r\npreferred_langcode:<\/span>\r\nplugin:<\/span> user_langcode<\/span>\r\nsource:<\/span> language<\/span>\r\nfallback_to_site_default:<\/span> true<\/span>\r\npreferred_admin_langcode:<\/span>\r\nplugin:<\/span> user_langcode<\/span>\r\nsource:<\/span> language<\/span>\r\nfallback_to_site_default:<\/span> true<\/span>\r\ninit:<\/span> init<\/span>\r\n# Custom Fields.<\/span>\r\nfield_first_name:<\/span> d7_first_name<\/span>\r\nfield_last_name:<\/span> d7_last_name<\/span>\r\nroles:<\/span>\r\nplugin:<\/span> migration_lookup<\/span>\r\nmigration:<\/span> d7_user_role<\/span>\r\nsource:<\/span> roles<\/span>\r\nuser_picture:<\/span>\r\n-<\/span>\r\nplugin:<\/span> default_value<\/span>\r\nsource:<\/span> picture<\/span>\r\ndefault_value:<\/span> null<\/span>\r\n-<\/span>\r\nplugin:<\/span> migration_lookup<\/span>\r\nmigration:<\/span> d7_file<\/span>\r\ndestination:<\/span>\r\nplugin:<\/span> entity:user<\/span>\r\nmigration_dependencies:<\/span>\r\nrequired:<\/span>\r\n-<\/span> d7_user_role<\/span>\r\noptional:<\/span>\r\n-<\/span> d7_field_instance<\/span>\r\n-<\/span> language<\/span>\r\n-<\/span> default_language<\/span><\/pre>\n
For user image migration, a separate YAML file must be added by ID name d7_file.<\/p>\n
Second step: Add a definition for source plugin<\/strong><\/h1>\n
Create the php class in location \/custom_module\/src\/Plugin\/migrate\/source\/User.php<\/p>\n
<?php<\/span>\r\nnamespace<\/span> Drupal<\/span>\\d10_users_migration<\/span>\\Plugin<\/span>\\migrate<\/span>\\source<\/span>;\r\nuse<\/span> Drupal<\/span>\\migrate<\/span>\\Row<\/span>;\r\nuse<\/span> Drupal<\/span>\\migrate<\/span>\\Plugin<\/span>\\migrate<\/span>\\source<\/span>\\SqlBase<\/span>;\r\n\/**\r\n* Extract users from Drupal 7 database.\r\n*\r\n* @MigrateSource<\/span>(\r\n* id = \"d7_user\",\r\n* source_module = \"migrate_plus\"\r\n* )\r\n*\/<\/span>\r\nclass<\/span> User<\/span> extends<\/span> SqlBase<\/span> <\/span>{\r\n\/**\r\n* {@inheritdoc<\/span>}\r\n*\/<\/span>\r\npublic<\/span> function<\/span> query<\/span>() <\/span>{\r\nreturn<\/span> $this<\/span>->select<\/span>('users'<\/span>, 'u'<\/span>)\r\n->fields<\/span>('u'<\/span>, array_keys<\/span>($this<\/span>->baseFields<\/span>()))\r\n->condition<\/span>('uid'<\/span>, 0<\/span>, '>'<\/span>)->orderBy<\/span>('uid'<\/span>, 'ASC'<\/span>);\r\n}\r\n\/**\r\n* {@inheritdoc<\/span>}\r\n*\/<\/span>\r\npublic<\/span> function<\/span> fields<\/span>() <\/span>{\r\n$fields<\/span> = $this<\/span>->baseFields<\/span>();\r\n$fields<\/span>['first_name'<\/span>] = $this<\/span>->t<\/span>('First Name'<\/span>);\r\n$fields<\/span>['last_name'<\/span>] = $this<\/span>->t<\/span>('Last Name'<\/span>);\r\nreturn<\/span> $fields<\/span>;\r\n}\r\n\/**\r\n* {@inheritdoc<\/span>}\r\n*\/<\/span>\r\npublic<\/span> function<\/span> prepareRow<\/span>(Row $row<\/span><\/span>) <\/span>{\r\n$uid<\/span> = $row<\/span>->getSourceProperty<\/span>('uid'<\/span>);\r\n\/\/ Get first name from d7 db.<\/span>\r\n$result<\/span> = $this<\/span>->getDatabase<\/span>()->query<\/span>('\r\nSELECT\r\nfld.field_first_name_value\r\nFROM\r\n{field_data_field_first_name} fld\r\nWHERE\r\nfld.entity_id = :uid\r\n'<\/span>, [':uid'<\/span> => $uid<\/span>]);\r\nforeach<\/span> ($result<\/span> as<\/span> $record<\/span>) {\r\n$row<\/span>->setSourceProperty<\/span>('d7_first_name'<\/span>, $record<\/span>->field_first_name_value);\r\n}\r\n\/\/ Get last name value from d7 db.<\/span>\r\n$result<\/span> = $this<\/span>->getDatabase<\/span>()->query<\/span>('\r\nSELECT\r\nfld.field_last_name_value\r\nFROM\r\n{field_data_field_last_name} fld\r\nWHERE\r\nfld.entity_id = :uid\r\n'<\/span>, [':uid'<\/span> => $uid<\/span>]);\r\nforeach<\/span> ($result<\/span> as<\/span> $record<\/span>) {\r\n$row<\/span>->setSourceProperty<\/span>('d7_last_name'<\/span>, $record<\/span>->field_last_name_value);\r\n}\r\nreturn<\/span> parent<\/span>::prepareRow<\/span>($row<\/span>);\r\n}\r\n\/**\r\n* {@inheritdoc<\/span>}\r\n*\/<\/span>\r\npublic<\/span> function<\/span> getIds<\/span>() <\/span>{\r\nreturn<\/span> [\r\n'uid'<\/span> => [\r\n'type'<\/span> => 'integer'<\/span>,\r\n'alias'<\/span> => 'u'<\/span>,\r\n],\r\n];\r\n}\r\n\/**\r\n* User base fields.\r\n*\r\n* @return<\/span> array\r\n* Base fields array.\r\n*\/<\/span>\r\nprotected<\/span> function<\/span> baseFields<\/span>() <\/span>{\r\n$fields<\/span> = [\r\n'uid'<\/span> => $this<\/span>->t<\/span>('User ID'<\/span>),\r\n'name'<\/span> => $this<\/span>->t<\/span>('Username'<\/span>),\r\n'pass'<\/span> => $this<\/span>->t<\/span>('Password'<\/span>),\r\n'mail'<\/span> => $this<\/span>->t<\/span>('Email address'<\/span>),\r\n'signature'<\/span> => $this<\/span>->t<\/span>('Signature'<\/span>),\r\n'signature_format'<\/span> => $this<\/span>->t<\/span>('Signature format'<\/span>),\r\n'created'<\/span> => $this<\/span>->t<\/span>('Registered timestamp'<\/span>),\r\n'access'<\/span> => $this<\/span>->t<\/span>('Last access timestamp'<\/span>),\r\n'login'<\/span> => $this<\/span>->t<\/span>('Last login timestamp'<\/span>),\r\n'status'<\/span> => $this<\/span>->t<\/span>('Status'<\/span>),\r\n'language'<\/span> => $this<\/span>->t<\/span>('Language'<\/span>),\r\n'picture'<\/span> => $this<\/span>->t<\/span>('Picture'<\/span>),\r\n'init'<\/span> => $this<\/span>->t<\/span>('Init'<\/span>),\r\n];\r\nreturn<\/span> $fields<\/span>;\r\n}\r\n\/**\r\n* {@inheritdoc<\/span>}\r\n*\/<\/span>\r\npublic<\/span> function<\/span> bundleMigrationRequired<\/span>() <\/span>{\r\nreturn<\/span> FALSE<\/span>;\r\n}\r\n\/**\r\n* {@inheritdoc<\/span>}\r\n*\/<\/span>\r\npublic<\/span> function<\/span> entityTypeId<\/span>() <\/span>{\r\nreturn<\/span> 'user'<\/span>;\r\n}\r\n}\r\n<\/pre>\n
Used methods \u2014<\/strong><\/p>\n
To fetch data from the Drupal 7 database, the query()<\/strong>\u00a0function is used.<\/p>\n
prepareRow()<\/strong>\u00a0is called to load data from tables $row->setSourceProperty() will provide any property in our \u201cprocess\u201d step.<\/p>\n
baseFields()<\/strong> describes the basic user fields the query() function uses.<\/p>\n
Drush commands to start migration:
\n<\/strong>1. For role migration
\ndrush migrate-import d7_user_role<\/p>\n
\"\"<\/p>\n
2. For users Migration
\ndrush migrate-import d7_user<\/p>\n
\"\"<\/p>\n
This process will migrate the users along with the password, custom & base fields on our Drupal 10 website.<\/p>\n
<\/div>","protected":false},"excerpt":{"rendered":"
This blog will target the migration of users & roles from the Drupal 7 website to the Drupal 10 website. Why should you migrate from Drupal 7 to Drupal 10? November 2023 will be the end of life for Drupal 7. With the release of Drupal 10, it is essential to migrate the website from […]<\/p>\n","protected":false},"author":1607,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"iawp_total_views":23},"categories":[3602],"tags":[1703],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/57836"}],"collection":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/users\/1607"}],"replies":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/comments?post=57836"}],"version-history":[{"count":2,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/57836\/revisions"}],"predecessor-version":[{"id":58153,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/57836\/revisions\/58153"}],"wp:attachment":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/media?parent=57836"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/categories?post=57836"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/tags?post=57836"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}