Jump to content

Extension:CategoryControl2

From mediawiki.org
MediaWiki extensions manual
CategoryControl
Release status: stable
Implementation User rights
Description Access control via group and category permissions.
Author(s) JLTRYtalk
Latest version 1.0.0
MediaWiki 1.31+
License Creative Commons Attribution NonCommercial Share Alike 3.0
Download github release v1.0.0
Translate the CategoryControl2 extension

The CategoryControl2 extension is meant to provide a very simple and flexible level of Per-Page Access Control by utilizing Categories and usergroups as the control method. It was based on CategoryControl extension (Kevin Kragenbrink, II ) that is archived

Usage

[edit]

Follow the Installation instructions below. Articles to be locked down should be added to a Category that has been specified in the $wgCategoryPermissions array. Users can then be added to the allowed groups using the standard mediawiki user rights management.

Download instructions

[edit]

Please cut and paste the code found in github release v1.0.0 and place it in $IP/extensions/CategoryControl2/CategoryControl.php. Note: $IP stands for the root directory of your MediaWiki installation, the same directory that holds LocalSettings.php.

Installation

[edit]

To install this extension, add the following to LocalSettings.php:

require_once("$IP/extensions/CategoryControl2/CategoryControl.php");

Configuration parameters

[edit]

The $wgCategoryPermissions variable is used to define permissions in groups for each category and action. If no permissions are defined for a category and action, then permission handling falls back to the standard $wgGroupPermissions.

$wgCategoryPermissions['category']['*'][] = 'sysop'; // Sysops can do anything they want with this category.
$wgCategoryPermissions['category']['*'][] = 'bureaucrat'; // Bureaucrats can do anything they want with this category.
$wgCategoryPermissions['category']['read'] = array( 'newgroup', 'othergroup' ); // Users who are in both NewGroup and OtherGroup can read pages in this category.