Extension:ImportUsers

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual - list
Crystal Clear action run.png
ImportUsers

Release status: beta

Implementation Special page, User identity, Database
Description Allows to import users in bulk from a CSV file
Author(s) Rouslan Zenetl, Yuriy Ilkiv
Last version 1.2 (2011-03-27)
MediaWiki 1.16+
Database changes No
License Public domain
Download
Added rights

import_users

Check usage and version matrix

The ImportUser extension adds special page, Special:ImportUsers, which can be used by bureaucrat (or others who have 'import_users' right) to import users from a CSV file to MediaWiki's user database.

Contents

Import File Format [edit]

The CSV file in UTF-8 consists of four columns:

  1. username
  2. password
  3. email
  4. real name

Delimited with commas. For example:

user1,pass1,user1@gmail.com,User One
user2,pass2,user2@gmail.com,User Two
user3,pass3,user3@gmail.com,User Three
user4,pass4,user4@gmail.com,User Four
user5,pass5,user5@gmail.com,User Five
user6,pass6,user6@gmail.com,User Six
.
.
.
userN,passN,userN@gmail.com,User Nnn
Do not quote the double-quotes since they are treated as part of the value! See here for additional information.

Duplicate/Collision handling [edit]

ImportUsers extension will never create duplicate user accounts.

What is account collision?

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

Collision handling behavior is determined by the "Replace existing users" check box.

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, that MediaWiki tolerates duplicate email addresses. In other words, there may be multiple accounts connected to the same email address. ImportUsers extension will not validate for duplicate email addresses.

Installation [edit]

  1. Download the source code directly from SVN
  2. Place the files in $IP/extensions/ImportUsers/
  3. Add
    require_once("$IP/extensions/ImportUsers/ImportUsers.php");
    
    to your wiki's LocalSettings.php
  4. Installation can now be verified through Special:Version on your wiki

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.

License [edit]

You are free to use this extension for any reason and mutilate it to your heart's liking. If you feel your work might benefit others, post your changes here.