Extension:AutoModerator

MediaWiki extensions manual

AutoModerator Release status: experimental
Description	Enables community-configured reversion of Machine Language-scored bad edits.
Author(s)	Jason Sherman, Susana Cárdenas Molinar Katherine Graessle
MediaWiki	1.43+
License	GNU General Public License 2.0 or later
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 being developed by the Moderator Tools team at the Wikimedia Foundation. You can read more about the project goals and provide feedback at Automoderator.

Please see Extension:AutoModerator/Deploying for guidance on requesting AutoModerator on your Wikimedia project.

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

For local development, these values are typically set in your LocalSettings.php. 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';
// The project database ID targets the LiftWing lang parameter (e.g., 'enwiki'). If not set, it will use the database name.
$wgAutoModeratorWikiId = null;
// If set to false, the 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. This can be done by editing the MediaWiki page directly or using the Community Configuration page at Special:CommunityConfiguration/AutoModerator.

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 limit editing further, you may use page protection.

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
AutoModeratorFalsePositivePageTitle	The page title where people will go to report false positive reverts.	A string or a null if no false positive page exists.	null
AutoModeratorSkipUserRights	AutoModerator will never check or revert edits made by accounts with one or more of these rights.	An array of strings that contains the user's right names.	[ "bot", "autopatrol" ]
AutoModeratorUseEditFlagMinor	Boolean that enables the minor edit flag for all AutoModerator edits.	true or false	false
AutoModeratorEnableBotFlag	Boolean that enables whether AutoModerator uses the Bot flag when making its edits.	true or false	false
AutoModeratorRevertTalkPageMessageEnabled	Boolean that enables sending talk page messages informing the user that an edit has been reverted.	true or false	false
AutoModeratorCautionLevel	Controls the caution level that AutoModerator uses when scoring edits.	A string from one of the following options: very-cautious, cautious, somewhat-cautious, or less-cautious.	very-cautious

Example "MediaWiki

AutoModeratorConfig.json"

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

{
    "AutoModeratorEnableRevisionCheck": true,
    "AutoModeratorFalsePositivePageTitle": "Wikipedia:Automoderator False Positive Reporting",
    "AutoModeratorSkipUserRights": [ "bot", "autopatrol" ],
    "AutoModeratorUseEditFlagMinor": true,
    "AutoModeratorEnableBotFlag": false,
    "AutoModeratorRevertTalkPageMessageEnabled": false,
    "AutoModeratorCautionLevel": "very-cautious"
}