Batch User Importer

Batch User Importer helps Drupal administrators create or update user accounts from Excel spreadsheets. It processes imports through Drupal's Batch API, making it suitable for both small and large user lists.

Features

• Imports users from .xlsx and .xls files.
• Creates new accounts or updates existing accounts matched by email address.
• Supports usernames, email addresses, passwords, roles, and account status.
• Processes large imports with Drupal's Batch API.
• Provides a downloadable Excel template with an instructions worksheet.
• Validates spreadsheet headers, email addresses, roles, status values, and required passwords.
• Reports separate totals for processed, created, updated, skipped, and failed rows.
• Allows the administrator to select the spreadsheet header row.

Requirements

• Drupal 10.2 or later, or Drupal 11.
• PHPSpreadsheet. Composer installs this dependency automatically.
• A configured Drupal private file system.

Installation

Install the stable release with Composer:

composer require drupal/batch_user_importer:^1.1
drush en batch_user_importer -y
drush cr

Configure file_private_path in settings.php before importing files.

Usage

1. Grant the Import users from Excel permission to trusted administrator roles.
2. Open /admin/people/user-import.
3. Download the provided Excel template.
4. Add one user per row without changing the column names.
5. Upload the spreadsheet and select the header row number.
6. Select Start import and review the results when processing finishes.

The maximum upload size is 20 MB.

Spreadsheet columns

Column Required Description username Yes A unique Drupal username. email Yes A valid email address. Existing users are matched by email. password New users Required for new users. A blank value does not change an existing user's password. roles No Comma-separated Drupal role machine names. status No Use active or inactive. A blank value defaults to active.

Accepted active values are 1, active, enabled, true, and yes. Accepted inactive values are 0, inactive, disabled, false, and no.

Upgrading from 1.0.0

Version 1.0.0 used the user_importer machine name. Uninstall the old module before installing version 1.1:

drush pm:uninstall user_importer -y
drush cr
composer require drupal/batch_user_importer:^1.1
drush en batch_user_importer -y

Support and development

Report bugs and request features in the Batch User Importer issue queue. Please search for an existing issue before creating a new one.