Extension:GroupWhitelist

This extension is professionally maintained by the WikiTeq team.

WikiTeq provides official support for MediaWiki LTS releases only. It may work with other MediaWiki releases.

MediaWiki extensions manual

GroupWhitelist Release status: stable
Implementation	User rights
Description	Allows to override per page permissions based on a whitelist
Author(s)	WikiWorks team
Maintainer(s)	WikiTeq team
Compatibility policy	For every MediaWiki release that is a Long Term Support release there is a corresponding branch in the extension.
MediaWiki	1.31+
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Download Git master browse repository (Phabricator · GitHub) commit history repository contributors (GitHub) code review README
Parameters $wgGroupWhitelistSourcePage $wgGroupWhitelistAPIAllow $wgGroupWhitelistRights $wgGroupWhitelistGroup
Hooks used UserGetRights getUserPermissionsErrors
Quarterly downloads	3 (Ranked 126th)
Translate the GroupWhitelist extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

The extension allows to grant users from selected group with a special per-page rights specifying affected pages list on a regular wiki page.

This extension was created for WikiWorks.

Installation

• Download and move the extracted GroupWhitelist 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/GroupWhitelist
• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'GroupWhitelist' );
  

•  Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration parameters

• $wgGroupWhitelistRights - A list of actions to be allowed
• $wgGroupWhitelistGroup - A group affected by the extension
• $wgGroupWhitelistSourcePage - A page to look for list of whitelisted pages
• $wgGroupWhitelistAPIAllow - API modules to be always granted with the right

The default configuration is:

$wgGroupWhitelistRights = [ 'edit' ];
$wgGroupWhitelistGroup = 'user';
$wgGroupWhitelistSourcePage = 'Mediawiki:Whitelist';
$wgGroupWhitelistAPIAllow = [];

and the Mediawiki:Whitelist contents could be:

* SomePage1
// Comments are allowed
* SomePage2
* SomaPage3

The settings above allow users from a `user` group to `edit` pages specified in the `Mediawiki:Whitelist` page contents (`SomePage1`, `SomePage2`, `SomePage3`).

Warning:

This extension will also add $wgGroupWhitelistRights to the API for requests coming from 127.0.0.1 regardless of user

See also

• Extension:InternalWhitelist - A similar extension that only allows whitelisting pages for reading by anonymous users.