Extension:GlobalUserrights

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
Crystal Clear action run.svg
GlobalUserrights
Release status: stable
Implementation Special page
Description Allows easy management of global user rights through Special:GlobalUserrights
Author(s) Mainframe98, Nathaniel Herman (Pinkytalk)
Latest version 1.5.0 (2017-10-02)
MediaWiki 1.15+
Database changes Yes
License GNU General Public License 2.0 or later
Download
Added rights
  • userrights-global
Hooks used
UserEffectiveGroups
SpecialListusersQueryInfo
LoadExtensionSchemaUpdates
UsersPagerDoBatchLookups
Translate the GlobalUserrights extension if it is available at translatewiki.net
Check usage and version matrix.

The GlobalUserrights extension enables global user groups and allows easy management of them via Special:GlobalUserrights. Global group changes are logged to Special:Log/gblrights (same place CentralAuth would log them). This extension is used in conjunction with $wgSharedDB.

Installation[edit]

  • Download and place the file(s) in a directory called GlobalUserrights in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'GlobalUserrights' );
    
  • Run the update script which will automatically create the necessary database tables that this extension needs.
  • Make sure global_user_groups is a shared table by adding it to $wgSharedTables in LocalSettings.php - e.g.
    $wgSharedTables[] = 'global_user_groups';.
  • Be sure to give the userrights-global right to users who need access to Special:GlobalUserRights; by default the staff group has this user right. If you would want to allow administrators to access the special page, you could add the following to the configuration file: $wgGroupPermissions['sysop']['userrights-global'] = true;
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

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

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

Usage[edit]

  1. Go to Special:GlobalUserrights
  2. Enter in the user name of the user whose global rights you want to change.
  3. Use the interface to add or remove global groups to/from the user and save.

System messages[edit]

The following new system messages are defined by this extension:

Message Default value Description
globaluserrights Global User Rights Management Special page title displayed on Special:SpecialPages and on Special:GlobalUserrights
gur-desc Easy global user rights administration Extension description shown on Special:Version
gur-rightslog-name Global rights log Log title for Special:Log/gblrights, the log where global user rights changes are stored. This will also be displayed on the dropdown menu on Special:Log.
gur-rightslog-header This is a log of changes to global rights. Displayed on Special:Log/gblrights, explaining the purpose of that log.
gur-rightslog-entry changed global group membership for $1 from $2 to $3 Log entry generated by this extension when a user's global groups are changed. $1 is the user whose groups were changed, $2 is the array of old groups and $3 is the array of new groups.
logentry-gblrights-rights $1 changed global group membership for $3 from $4 to $5 New style log entry generated by this extension when a user's global groups are changed. $1 is the user who changed the right, $2 is the user's gender, $3 is the user whose groups were changed, $4 is the array of old groups, $5 is the array of new groups and $6 is the gender of the user whose groups where changed.
right-userrights-global Manage global user rights Description of the user right, will be shown on Special:ListGroupRights