Extension:PagePermissions
If you need per-page or partial page access restrictions, you are advised to install an appropriate content management package. MediaWiki was not written to provide per-page access restrictions, and almost all hacks or patches promising to add them will likely have flaws somewhere, which could lead to exposure of confidential data. We are not responsible for anything being leaked.
For further details, see Security issues with authorization extensions |
 Release status: stable |
|
|---|---|
 |
|
| Implementation | User rights |
| Description | Straightforward per-user per-right per-page protection |
| Author(s) | Pavel Astakhov, Sanjay Thiyagarajan (Techwizzietalk) |
| Maintainer(s) | User:Techwizzietalk |
| Latest version | 1.0 |
| Compatibility policy | For every MediaWiki release that is a Long Term Support release there is a corresponding branch in the extension. |
| MediaWiki | 1.38+ |
| Database changes | Yes |
| Tables | pagepermissions |
| License | GNU General Public License 2.0 or later |
| Download | |
|
|
| Quarterly downloads | 18 (Ranked 155th) |
| Translate the PagePermissions extension if it is available at translatewiki.net | |
| Issues | Open tasks · Report a bug |
The PagePermissions extension provides per page access based on default / custom roles set by the wiki administrator. It allows those with the pagepermissions right (administrators by default) to use a wizard-like interface where they could add the list of usernames for each role specified in the configuration.
This extension is based in part on the UserProtect extension.
FeaturesEdit
- Stores its data in the MediaWiki database.
- Doesn’t disable caching.
- Has a minimalist interface
- Adds and removes rights on the fly.
- Overrides the built-in core per-group protection system with finer per-user protection.
UsageEdit
A user with the pagepermissions right is provided with the "Page Permissions" item in the page actions menu. Click it to add or remove allowed restrictions to the current page on per-user basis. Just start typing user names in the appropriate right field seperated by comma (,). Each field allows multiple values. Once you are done, submit the form.
InstallationEdit
- Download and place the file(s) in a directory called
PagePermissionsin yourextensions/folder. - Add the following code at the bottom of your
LocalSettings.php:wfLoadExtension( 'PagePermissions' );
- Run the update script which will automatically create the necessary database tables that this extension needs.
- Configure as required.
Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
ConfigurationEdit
ParametersEdit
$wgPagePermissionsRoles- Sets which user rights can be modified by the extension. Defaults to:
$wgPagePermissionsRoles = [ "reader" => ["read"], "editor" => ["read", "edit"], "manager" => ["read", "edit", "move"], "owner" => ["read", "edit", "move", "rollback", "delete", "pagepermissions"] ];
- The extension will work with any MediaWiki core or extension page-related right.
User rightsEdit
- pagepermissions
- Allows users to use the "PagePermissions" page action in order to add or remove user rights for this page. Defaults to:
$wgGroupPermissions['sysop']['pagepermissions'] = true;