Jump to content

Extension:ShowRealUsernames

From mediawiki.org
MediaWiki extensions manual
ShowRealUsernames
Release status: stable
Implementation Special page
Description Extends Special:ListUsers to also show each user's real name and/or other user-specific information.
Author(s) Paul Lustgarten and RV1971
Latest version 1.4.0 (2018-04-17)
MediaWiki 1.30+
PHP 5.4+
License GNU General Public License 3.0 or later
Download
  • $wgShowRealUsernamesFields
  • $wgShowRealUsernamesInline
  • showrealname
Quarterly downloads 4 (Ranked 135th)
Translate the ShowRealUsernames extension if it is available at translatewiki.net

The ShowRealUsernames extension extends the user listings produced by Special:ListUsers to include the registered real name of each user, displayed immediately following the wiki user name, and/or other user-specific information.

Installation

  • Download and move the extracted ShowRealUsernames folder to your extensions/ directory.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ShowRealUsernames
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'ShowRealUsernames' );
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Upgrading

To upgrade, simply install the new version at the place of the old one.

From versions before 1.2

Your existing configuration works as before, but you might like to take advantage of the new features.

Configuration

By default, the user's real name is appended to the wiki name in Special:ListUsers. You can replace the wiki name with the real name by setting

$wgShowRealUsernamesInline = true;

in your LocalSettings.php.

The fields retrieved from the database by the ShowRealUsernames extension are configured in $wgShowRealUsernamesFields, which currently defaults to 'user_real_name', 'user_name', 'user_email'. You can customize this in your LocalSettings.php.

The system messages sru-realname-inline and sru-realname-append are provided to format the name. Parameters ($1, $2, …) are replaced by the fields defined in $wgShowRealUsernamesFields in the order of definition.

Only users having the showrealname right do see the real names. By default, this right is granted to all registered users. To restrict it to a group add something like the following lines to your LocalSettings.php:

$wgGroupPermissions['user']['showrealname'] = false;

$wgGroupPermissions['bureaucrat']['showrealname'] = true;

Usage

This extension operates automatically whenever the Special:ListUsers page is displayed.

Release notes

These are the release notes for version 1.4.0. See Extension:ShowRealUsernames/History for older releases.

Configuration changes

The extension is now loaded using the wfLoadExtension() mechanism introduced in MediaWiki 1.25. It is therefore incompatible with older MediaWiki versions.

Bugfixes

Removed closing ?> at end of files.

Alternative extension