Extension:AutoModerator

MediaWiki extensions manual

AutoModerator Release status: unstable
Description	Enables community-configured reversion of Machine Language-scored bad edits.
Author(s)	Jason Sherman, Susana Cárdenas Molinar
MediaWiki
License	No license specified
Download	Download extension Git [?]: Download Git master browse repository (GitHub) commit history repository contributors (GitHub) code review
Help	Help:Extension:AutoModerator
Translate the AutoModerator extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

The AutoModerator extension is under development by the Moderator Tools team at the Wikimedia Foundation. Read more about the project at Automoderator.

This page will be updated as usage and local setup steps are defined.

Installation

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

  wfLoadExtension( 'AutoModerator' );
  

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

Configuration

Internal configuration

These values are typically set in your LocalSettings.php for local development. The default values are shown here.

// Revert risk probability threshold; Edits scored above this value will be reverted.
$wgAutoModeratorRevertProbability = 0.99;
// Username for AutoModerator system account.
$wgAutoModeratorUsername = 'AutoModerator';
// Name of page used for on-wiki config; must be in NS_MEDIAWIKI and end with .json; only variables listed in AutoModeratorOnWikiConfigAllowList may be overridden on wiki.
$wgAutoModeratorWikiConfigPageTitle = 'MediaWiki:AutoModeratorConfig.json';
// Database id of project used to target liftwing lang parameter. (eg. 'enwiki'). If not set, it'll use database name.
$wgAutoModeratorWikiId = null;
// If set to false, on-wiki configuration will be ignored.
$wgAutoModeratorEnableWikiConfig = true;

On-wiki configuration

To configure AutoModerator on a wiki, including enabling it to run, local configuration must also be completed at MediaWiki:AutoModeratorConfig.json. For now, this must be done by directly editing the page, but in the future will incorporate Community configuration for ease of configuring.

You'll need the editsitejson right to edit MediaWiki:AutoModeratorConfig.json, which is held by interface-admin and sysop groups on most wikis. You can check Special:ListGroupRights on your wiki to be sure. If you wish to further limit editing, you may use page protection to do so.

Config	Description	Allowed values	Default if omitted
AutoModeratorEnableRevisionCheck	Enables or disables AutoModerator. If set to true, AutoModerator will begin running immediately after the page is saved. AutoModerator can be immediately disabled by setting this value to false.	true or false	false
AutoModeratorUndoSummary	Sets the edit summary used by AutoModerator when reverting an edit. The following variables are available: $1 - Revision ID of the reverted edit $2 - Username of the reverted user	Any string, up to 800 characters.	Undo revision [[Special:Diff/$1|$1]] by [[Special:Contributions/$2|$2]] ([[User talk:$2|talk]])
AutoModeratorUndoSummaryAnon	Similar to above, this sets the edit summary used by AutoModerator when reverting an edit of an anonymous editor on wikis with $wgDisableAnonTalk set to false; this currently does not apply to any production wikis and can generally be ignored. The following variables are available: $1 - Revision ID of the reverted edit $2 - Username of the reverted user	Any string, up to 800 characters.	Undo revision [[Special:Diff/$1|$1]] by [[Special:Contributions/$2|$2]]

Example MediaWiki:AutoModeratorConfig.json

This example enables revision checks (and potential reverts) and explicitly sets the edit summary to the default value.

{
    "AutoModeratorEnableRevisionCheck": true,
    "AutoModeratorUndoSummary": "Undo revision [[Special:Diff/$1|$1]] by [[Special:Contributions/$2|$2]] ([[User talk:$2|talk]])"
}