Jump to content

Extension:AbuseFilterBypass

From mediawiki.org
MediaWiki extensions manual
AbuseFilterBypass
Release status: stable
Implementation User rights
Description Allows privileged users to bypass AbuseFilter checks
Author(s)
Latest version 1.1.1 (continuous updates)
Compatibility policy Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki 1.39.8+
License GNU General Public License 2.0 or later
Download
abusefilter-bypass
Quarterly downloads 16 (Ranked 126th)
Translate the AbuseFilterBypass extension if it is available at translatewiki.net

The AbuseFilterBypass extension allows privileged users to skip all AbuseFilters defined and configured in the AbuseFilter  extension. It is primarily intended for wiki farms like Fandom or ShoutWiki , where there is a need to have one user group—staff for these sites—that is global (shared between all wikis on the farm) and more trusted than individual local wikis' admins. For a regular single-wiki installation, there is probably no need to install this extension and people who can edit abuse filters can easily edit or disable harmful filters that would unintentionally affect the wiki's admins.

The AbuseFilterBypass extension requires the AbuseFilterShouldFilterAction hook, which was added to the AbuseFilter extension in commit 7edf12dbc6d9421d668619acd4abfe68af081f41, committed on 13 August 2019 (see phab:T229252).

The extension was originally written by Nelson Monterroso for Fandom and amended in July 2019 by Jack Phoenix for ShoutWiki .

Installation[edit]

  • Download and move the extracted AbuseFilterBypass 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/AbuseFilterBypass
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'AbuseFilterBypass' );
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

User rights[edit]

The extension adds one new user right, abusefilter-bypass, which by default is granted to the staff user group. (By default, there is no staff user group in MediaWiki, so if such a group doesn't exist, this extension effectively creates it by giving it the abusefilter-bypass user right.)

See also[edit]

  • Extension:StaffPowers — similar extension which makes select users immune to local blocks (so that e.g. local admins cannot block wiki farm staff)