Extension:ImportUsers

File:Wikiteq - logo.png

<translate> This extension is professionally maintained by the WikiTeq team.</translate>

<translate> WikiTeq provides official support for [[<tvar name=1>Special:MyLanguage/Version lifecycle</tvar>|MediaWiki LTS releases only]].</translate> <translate> It may work with other MediaWiki releases.</translate>

MediaWiki extensions manual

File:OOjs UI icon advanced-invert.svg ImportUsers Release status: stable
Implementation	Special page , User identity , Database
Description	Allows to import users in bulk from a CSV file
Author(s)	Rouslan Zenetl Yuriy Ilkiv
Maintainer(s)	WikiTeq team
Latest version	2.2.1 (2023-01-14)
Compatibility policy	For every MediaWiki release that is a Long Term Support release there is a corresponding branch in the extension.
MediaWiki	1.38+
Database changes	No
License	The Unlicense
Download	<translate> Download extension</translate> <translate> Git</translate> [?]: <translate> Download Git master</translate> <translate> browse repository</translate> (GitHub) <translate> commit history</translate> <translate> repository contributors (GitHub)</translate> <translate> code review</translate> README CHANGELOG
Added rights import_users
Quarterly downloads
Public wikis using
Translate the ImportUsers extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

The ImportUsers extension adds special page, "Special:ImportUsers", which can be used by bureaucrats (or other users who have the import_users permission) to import users from a CSV file to MediaWiki's user database.

Usage

Import File Format

The CSV file in UTF-8 without BOM encoding consists of four or five columns, delimited with commas:

1. username
2. password
3. email
4. real name
5. user groups (optional; if the user is a member of more than one group, put each group in its own column in the CSV file - do not embed them with commas in one column)

Be sure the CSV file has the correct line feeds. Files with Macintosh line feeds will process only the first line.

Example

user1,pass1,user1@example.org,John Doe
user2,pass2,user2@example.org,Jane Doe,editor
user3,pass3,user3@example.org,Jonnie Doe,editor,staff

Do not quote text with double-quotes since they are treated as part of the value, e.g. "user1","pass1","user1@example.org","John Doe","editor"

Duplicate/Collision handling

This extension will never create duplicate user accounts. Collision handling behavior is determined by the "Replace existing users" check box.

What is account collision?

Two accounts are in collision (or are duplicates of each other) if their login names (user names) are equal.

What can be done?

• When "Replace existing users" check box is clear (unchecked), ImportUsers extension will ignore records in the input file which are duplicates of existing accounts.
• When "Replace existing users" check box is checked, ImportUsers extension will update corresponding accounts with data from input file.

File:OOjs UI icon lightbulb-yellow.svg <translate> Note:</translate> MediaWiki tolerates duplicate email addresses. In other words, there may be multiple accounts connected to the same email address. This extension will not validate for duplicate email addresses.

Installation

• <translate> <tvar name=1>Download</tvar> and place the file(s) in a directory called <tvar name=name>ImportUsers</tvar> in your <tvar name=ext>extensions/</tvar> folder.</translate>
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate>

  wfLoadExtension( 'ImportUsers' );
  

• Configure if necessary.
• File:OOjs UI icon check-constructive.svg <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>

Configuration

User right

The user right "import_users" is by default assigned to the "bureaucrat" user group. In case you would like to assign the right to an additional user group, e.g. "sysop" add the following line to your "LocalSettings.php" file after the inclusion of the extension as described in the "Installation" section above:

$wgGroupPermissions['sysop']['import_users'] = true;

Maintenance

After importing users you might want to run MediaWiki's "initSiteStats.php" maintenance script to update the statistics of your wiki on registered users.

See also

• MediaWikiAuth – Extension which is designed for "on demand" import of old accounts into a new wiki
• UserExport – Extension that allows to export users in bulk to a CSV file