Migrating Address Book in Drupal 8 website using Process plugin
Migration is a term, which all the developers who have started working in Drupal 8 have gone through once at least in their development cycle. Migration can be done of many things like site migration (i.e migrate from Drupal 7 to Drupal 8), user migration, content migration. In simple terms, we can migrate all types of entity in Drupal 8.
How this migration works:
Migrate works by reading a row from a source plugin then running each property through a pipeline of Process plugins thus, resulting in a row to a destination plugin.
Why we write Process plugin?
Each Process plugin gets the current value and returns a value.
Here we are going to look how this Process plugin works. We are going to migrate Address fields using Process plugin in Drupal 8. Follow the below steps.
Step 1: Install the following modules
- Migrate Tools
- Migrate plus
- Migrate Source CSV
Step 2: Create a custom module. ‘custom_addressbook_migration’
- Create a .info file :
Step 3: Create assets folder inside the module and paste your CSV file inside it.
- Prepare the CSV as shown :
Step 4: Create Process plugin
- Add a new plugin class, called AddressFieldMigration, in your module at src/Plugin/migrate/process/AddressFieldMigration.php.
- The @MigrateProcessPlugin annotation tells migrate about the new Process plugin and the id key is used to select this plugin in a migration’s mappings. The class should extend Drupal\migrate\ProcessPluginBase and override the transform() method. This method will be passed to the incoming source value and is responsible for returning the modified destination value.
- Here, in CSV, we are passing the country name, but address requires country code so we have made use of CountryManager Class to get the country code from given country name.
- We get the region names in form of code mostly for Foreign Countries, In the CSV, you can see it is given as ‘CA’. So, to get the state name we have to make use of methods from SubdivisionRepository Class.
Step 5: Now, we have to create a Migrate Configuration file and import this configuration.
- Address is created under profile entity so the destination plugin name is entity: profile.
- Process plugin is written to map all the columns given in source CSV file to its respective fields in address entity. In Migration, always we have to mention the source, destination, and process.
Step 6: Import the above configuration file into Drupal site.
- Goto admin > config > development > configuration
- Click on Import Tab and Choose Single Item
- Select the Configuration Type as Migration
- Paste the above configuration file and click on Import.
Step 7: Drush Commands to implement
- drush ms - you will see the status of all the migrations.
- drush mi address_fields_migration.('address_fields_migration' is the id in the configuration file)
Step 8: Conclusion :
Now, Go to admin > config > people > profiles and you will see the list of address that has been migrated. This is how address fields are migrated using process plugin in Drupal 8.
To know more about migration using Process plugin, Refer Drupal 8 Process Plugin
Since I have mentioned only a few drush commands related to migration, you can check more about this Here
Please put your doubts, suggestions or queries related to above topic in the below comment box, and I will try to answer them. You may also like to check out our previous blog on "Drupal 8: Why & How to Migrate".