Extension:UserExport

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.svg
UserExport

Release status:Extension status stable

ImplementationTemplate:Extension#type Special page, Data extraction
DescriptionTemplate:Extension#description Allows to export user name and email to a CSV file
Author(s)Template:Extension#username Rodrigo Sampaio Primo (RodrigoSampaioPrimotalk)
Latest versionTemplate:Extension#version 1.3.0 (2018-06-20)
MediaWikiTemplate:Extension#mediawiki 1.25+
PHPTemplate:Extension#php 5.4+
Database changesTemplate:Extension#needs-updatephp No
LicenseTemplate:Extension#license GNU General Public License 2.0 or later
Download
README
CHANGELOG
Added rightsTemplate:Extension#rights
userexport

Translate the UserExport extension if it is available at translatewiki.net

Check usage and version matrix.

The UserExport extension allows to export the user name and email of all MediaWiki users to a CSV-file via a new special page called "Special:UserExport".

Usage[edit]

This extension creates a new restricted special page called "Special:UserExport" with the title User Export which has only a button to trigger the generation of the CSV file. Click on this button and download the file. The data gets exported in "UTF-8".

Installation[edit]

  • Download and place the file(s) in a directory called UserExport in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'UserExport' );
    
  • Configure at your convenience
  • YesY Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.31 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.31 and earlier), instead of wfLoadExtension( 'UserExport' );, you need to use:

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

Configuration[edit]

User right

The user right "userexport" will have to be set for an existing user group, e.g. "bureaucrat" or preferably for a new user group:

$wgGroupPermissions['userexport']['userexport'] = true;
$wgGroupPermissions['bureaucrat']['userexport'] = true;
Prior to version 1.1.0 of this extension the user right was automatically assigned to the bureaucrat user group.