Jump to content

Extension:UserExport

From mediawiki.org
MediaWiki extensions manual
UserExport
Release status: stable
Implementation Special page , Data extraction
Description Allows to export user name and email to a CSV file
Author(s) Rodrigo Sampaio Primo (RodrigoSampaioPrimotalk)
Maintainer(s) Mark A. Hershberger
Latest version 2.1.1 (2020-04-15)
MediaWiki 1.34+
PHP 7.2+
Database changes No
Composer mediawiki/user-export
License GNU General Public License 2.0 or later
Download
README
CHANGELOG
userexport
Quarterly downloads 4 (Ranked 132nd)
Translate the UserExport extension if it is available at translatewiki.net

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". The extension cannot export passwords and user groups.

Usage

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

  • 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 file:
    wfLoadExtension( 'UserExport' );
    
  • Configure as required.
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration

User right

By default the "userexport" permission provided by this extension is assigned to the "bureaucrat" user group.

In case you would like to change this add the following lines to your "LocalSettings.php" file after the inclusion of the extension as described in the "Installation" section above:

$wgGroupPermissions['bureaucrat']['userexport'] = false; // remove from "bureaucrat" group
$wgGroupPermissions['userexport']['userexport'] = true; // add to dedicated "userexport" group

See also