Extension:ImportUsers

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
OOjs UI icon advanced.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
Latest version 2.2.0 (2018-03-03)
MediaWiki 1.25+
Database changes No
License Public domain
Download
README
CHANGELOG
import_users
Translate the ImportUsers extension if it is available at translatewiki.net
Check usage and version matrix.
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[edit]

Import File Format[edit]

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[edit]

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.

Note Note: 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[edit]

  • Download and place the file(s) in a directory called ImportUsers in your extensions/ folder.

To users running MediaWiki 1.30 or earlier:

The instructions above describe the new way of installing this extension using wfLoadExtension(). If you need to install this extension on these earlier versions (MediaWiki 1.30 and earlier), instead of wfLoadExtension( 'ImportUsers' );, you need to use:

require_once "$IP/extensions/ImportUsers/ImportUsers.php";

Configuration[edit]

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[edit]

After importing users you might want to run initSiteStats.php (MW ≥ 1.21.x) or initStats.php (MW ≤ 1.20.x) to update the statistics of your wiki on registered users.

See also[edit]

  • MediaWikiAuth extension which is designed for "on demand" import of old accounts into a new wiki