Extension:Moderation

MediaWiki extensions manual

Moderation Release status: stable
Implementation	Special page
Description	Sends all edits and uploads from new users to moderation.
Author(s)	Edward Chernenko
Latest version	1.7.9 (2024-01-13)
Compatibility policy	Master maintains backward compatibility.
MediaWiki	1.39+ (master branch) 1.35-1.38 (REL1_35 branch) 1.31-1.34 (REL1_31 branch) 1.27-1.30 (REL1_27 branch) 1.23-1.26 (REL1_23 branch)
PHP	7.0+
Database changes	Yes
Tables	moderation moderation_block
License	GNU General Public License 3.0 or later
Download	GitHub: project page git repository URL [help ] commit history
Parameters $wgModerationEnable $wgModerationTimeToOverrideRejection $wgModerationOnlyInNamespaces $wgModerationIgnoredInNamespaces $wgModerationNotificationEnable $wgModerationEmail $wgModerationNotificationNewOnly
Added rights moderation skip-moderation skip-move-moderation moderation-checkuser
Hooks used AlternateEdit ApiBeforeMain ApiCheckCanExecute BeforePageDisplay CheckUserInsertForRecentChange EchoCanAbortNewMessagesAlert EditFilter EditFormInitialText EditFormPreloadText EditPage::showEditForm:fields FileUpload GetNewMessagesAlert getUserPermissionsErrors ListDefinedTags LoadExtensionSchemaUpdates LocalUserCreated MultiContentSave PageForms::EditFormInitialText PageForms::EditFormPreloadText PageMoveCompleting PageSaveComplete RecentChange_save RevisionFromEditComplete SpecialPageBeforeExecute TitleMove UploadVerifyUpload wgQueryPages
Hooks provided ModerationIntercept ModerationContinueEditingLink ModerationPending
Translate the Moderation extension

The Moderation extension provides protection against vandalism for small and medium wikis.

This is one of the most effective anti-vandal protection methods and has very little impact on legitimate users.

Introduction

How does it work?

1. Every edit (or image upload) by a new user is sent to a moderation queue.
2. Until the moderator approves this edit, the page is unchanged. Pending edits also do not appear on the page history nor in RecentChanges.
3. The new user can see their edit and continue editing their own version of the page.

How do the admins moderate?

1. A new special page is provided (Special:Moderation). It's much like the RecentChanges page, but has "Approve", "Reject", "Approve all" and "Reject all" buttons.
2. Rejected edits go into the rejected archive.
3. Approved edits are applied normally.
4. Logs of "who approved what" are maintained. Only the moderators can see them.
5. If edit conflict is detected and it can't be resolved automatically, the moderator has a merge button to apply the edit manually.

Why is it good?

1. New users are not discouraged by annoying captchas , phone number verifications, etc. They edit normally, like they would do in MediaWiki without moderation.
2. Blocks become practically obsolete. And blocks are not good (consider the chance of hitting a legitimate user with a range block, or inability to allow good edits from a not-very-adequate user who sometimes has the urge to vandalize a page or two).
3. Vandalism out of "wanting to be noticed" is discouraged. No one would sit for 5 hours looking for new and new proxies to make admin angry, if it's known that all those actions are not a problem.
4. Vandalism methods like "vandalizing one page from two accounts to prevent one-click rollback" are no longer effective.
5. Website can operate in anonymous networks like TOR or I2P.
6. Users can hide their mistakes from appearing in the revision history and even from moderators by fixing them in time.
7. Since any edit is only permanently recorded upon approval, users can correct botched edit summaries.

Alternatives

Moderation log

Does MediaWiki have other counter-vandalism methods? In brief - not really.

MediaWiki was developed for Wikipedia. At any given time, Wikipedia has hundreds of volunteers willing to revert vandalism in real time. Almost every other wiki besides Wikipedia doesn't have that kind of advantage. The built-in counter-vandalism idea of MediaWiki is that vandalism takes more time than reverting it. Normally that's true, but this does a poor job at discouraging vandalism, and the admins still have to check for vandalism often, even if the reverting itself doesn't take much of their time.

There are three known methods of fighting vandalism:

1. Make all edits hard. For example, Lurkmore.to imposes a strong captcha on all edits from new users, and it takes a lot of edits to finally be able to edit without the captcha. Therefore the vandal has to spend a lot of time to do a handful of edits.

   The obvious minus is that all legitimate users have to bypass the captcha as well, which could discourage minor edits like spelling fixes.

2. Enforce user identification - for example, login via Facebook. If the social network verifies that all its users have a valid mobile phone number, then each vandalism attempt requires the vandal to go to the shop and buy a new SIM card. This method is extremely effective, though eliminates the anonymous editing and turns away the users who don't have an account in any supported social network.

   A strong minus of this method is the impact on users' privacy. In non-democratic countries editing a page on politics can result in government trying to identify and persecute the user. For example, Lurkmore.to was contacted by Russian "anti-extremist special force" with demands to disclose information about the authors of pages about Ramzan Kadyrov and Molotov cocktail.[1]

3. Mitigate the results of vandalism. For example, a user can create 100 pages with offensive titles, but they can all be deleted by two clicks in Extension:Nuke . Moderation extension belongs to this category.

Is this extension stable?

This extension is stable. It has been deployed in production on Russian Uncyclopedia (absurdopedia.net) since November 2014.

The extension has an automated testsuite with significant coverage (phpunit and Selenium). Every change to Moderation is automatically tested on:

1. newest version of MediaWiki
2. Latest LTS versions of MediaWiki (such as 1.43 or 1.39) that haven't been declared obsolete

Feel free to contact the author if you have any questions.

What's the difference from FlaggedRevs or Approved Revs?

Extension:FlaggedRevs and Extension:Approved Revs hide the bad revisions only from readers. The vandal edits will still exist in history and RecentChanges, and all editors will stumble upon them when they try to edit the page which was vandalized. Therefore editors would have to revert vandalism quickly.

On the other hand, Moderation completely eliminates vandal edits: non-approved revisions are simply not created in page history, etc. This ensures that not only readers, but also other editors won't see the vandal edits in any of the pages.

In short, (1) FlaggedRevs is for quality control but doesn't help against persistent vandalism. (2) Moderation is specifically against vandalism and renders it completely ineffective.

	Moderation	FlaggedRevs/ApprovedRevs
Do readers see vandalism?	No	No
Do editors see vandalism?	No	Yes
Does vandalism remain in page history?	No	Yes
Can quickly reject all edits by user?	Yes	No
Can other editors improve non‑approved edits? (not vandalism)	No	Yes

Installation

For modern versions of MediaWiki (1.39+), use the following instruction:

• Check-out the sources with git clone https://github.com/edwardspec/mediawiki-moderation.git and place the file(s) in a directory called Moderation in your extensions/ folder.
• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'Moderation' );
  

• Run the update script which will automatically create the necessary database tables that this extension needs.
•  Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

This extension should be enabled last in your "LocalSettings.php" file after all other settings and extensions.

Installation for older versions of MediaWiki

For MediaWiki 1.35-1.38, replace the above-mentioned "git clone" command with the following: git clone -b REL1_35 https://github.com/edwardspec/mediawiki-moderation.git

For MediaWiki 1.31-1.34, replace the above-mentioned "git clone" command with the following: git clone -b REL1_31 https://github.com/edwardspec/mediawiki-moderation.git

For MediaWiki 1.27-1.30, replace the above-mentioned "git clone" command with the following: git clone -b REL1_27 https://github.com/edwardspec/mediawiki-moderation.git

For MediaWiki 1.23-1.26, replace the above-mentioned "git clone" command with the following: git clone -b REL1_23 https://github.com/edwardspec/mediawiki-moderation.git

These versions may still receive security fixes (if any), but not new features.

Configuration

Parameters for LocalSettings.php

• $wgModerationEnable

  If set to false, then new edits are applied as usual (not sent to moderation). Default: true.

  $wgModerationTimeToOverrideRejection

  Time (in seconds) after which rejected edit could no longer be approved. Default: 2 weeks. Note: old rejected edits are NOT deleted (moderators can always look at them in Rejected folder even if this time has elapsed).

  $wgModerationOnlyInNamespaces

  If set to an array of namespace numbers (e.g. $wgModerationOnlyInNamespaces = [ NS_MAIN, NS_FILE ];), moderation is only enabled in these namespaces (edits in other namespaces will bypass moderation). Default (empty array): moderation is enabled everywhere.

  $wgModerationIgnoredInNamespaces

  If set to an array of namespace numbers (e.g. $wgModerationIgnoredInNamespaces = [ NS_MAIN, NS_FILE ];), non-automoderated users can bypass moderation in these namespaces. Default (empty array): moderation can't be bypassed anywhere.

  $wgModerationNotificationEnable

  If true, notification email will be sent to $wgModerationEmail (e.g. $wgModerationEmail = 'send.to.this.address@example.com';) each time an edit is queued for moderation. Default: false.

  $wgModerationNotificationNewOnly

  If true, only notify about new pages (but not about edits in existing pages). Default: false.

See also: #Configuration options ONLY for pre-publish review (options not recommended for 95% of wikis).

Editing notices

When a user who is not in a trusted group edits a page, a message is added to the top of the page informing the user about moderation. You can edit this message by editing the MediaWiki:Moderation-edit-queued page.

User rights

This extension adds two groups (automoderated and moderator), which have the following rights:

Right	What can the user do?	Who has this right? (by default)
skip-moderation	Edits are applied as usual (not sent to moderation).	automoderated, sysop, bot
skip-move-moderation	Page moves are applied as usual (not sent to moderation).	automoderated, sysop, bot
moderation	Can access Special:Moderation	moderator, sysop
moderation-checkuser	Can see IPs of registered users on Special:Moderation.	checkuser

Additional anti-vandalism tips

In order to prevent vandalism, the following additional measures should be applied:

1. Please restrict the renaming of pages to a trusted group (not just automoderated), because it can be used for difficult-to-revert vandalism.

   $wgGroupPermissions['automoderated']['skip-move-moderation'] = false;
   $wgGroupPermissions['sysop']['skip-move-moderation'] = true;
   

2. Registering new accounts with offensive names is still a way for a vandal to show itself in the RecentChanges. A simple solution is to remove newusers log from RecentChanges:

   $wgLogRestrictions["newusers"] = 'moderation';
   

Recommended use / good practices

The following good-practices are advised:

1. Only vandalism should be Rejected. Not-so-good edits with good intentions (e.g. adding excessive plot details into the wiki's article about a movie) are better made Approved and then reverted as usual, and with a reason in the edit summary. This way the author is not offended and the text is saved in page history, viewable by anyone for transparency and editor accountability.
2. Any user that is deemed legitimate (does N good edits) should be added into automoderated group.
3. Adding users to automoderated group via $wgAutopromote is NOT recommended, as it motivates the vandals to do many very-minor edits (e.g. adding interwiki). Better promote them to automoderated manually for one good edit and not promote for 30 useless-edits-made-for-count.
4. Abstain from using blocks . Don't protect pages "just in case", except maybe for important templates.
5. Allow the full rehabilitation of users with a bad history of editing. Their useful edits to the articles should be allowed, no matter how many times they were blocked. At the same time, trolling on talk pages should be rejected, so are the purposely-low-quality edits.
6. Please note that an editor who appears to be resubmitting a rejected edit does not necessarily imply an intent to edit-war, but the editor might have made changes to their pending edit without noticing that it was rejected in the meantime.

Non-recommended use: Moderation as pre-publish review extension

Moderation is an anti-vandalism tool first, but some wikis use it for quality control. For example, a wiki of scientific works might choose to:

1. Not Approve any edits until they meet the strict quality standards of the industry.
2. Not Reject any edits that are not yet good enough, so that the author could continue editing it as long as necessary.

Pros of this approach:

1. New page appears as a fully reviewed, correctly formatted document with no typos, etc.
2. No one except the author and moderators would see the imperfect revisions.

Cons:

1. Other users can't improve the article until it is Approved. In fact, they won't even know that it exists.
2. Pending changes don't have an "edit history". Moderation stores only 1 pending change for each Page/User pair. That's inconvenient if you are preparing your page for publication for weeks. User can even accidentally delete the necessary text in their pending revision, and it won't be recoverable.

Configuration options ONLY for pre-publish review

The following parameters are only needed when using Moderation for review. They are not recommended for 95% of wikis (when following the Best Practices, they are totally not needed).

• $wgModerationPreviewLink

  If true, Preview link is shown on Special:Moderation. Default: false
  Why not recommended? Answer: when following Best Practices, you would never Reject a good change just because it is formatted poorly. Whether this edit is good or not, you know from "diff" link. "Preview" link tells you "how is this page formatted", which shouldn't affect your decision.

  $wgModerationEnableEditChange

  If true, moderators can modify the text of pending changes before Approving. Default: false.
  Why not recommended? Answer: easy to mess up. Moderator can accidentally delete the text of pending edit (and it won't be recoverable). Furthermore, these changes are not attributed to moderator (after approval, it looks as if the original author made the edit this way), which is creepy.

Allowing moderators to mark users as automoderated

By default, any sysop can add users to automoderated and moderator groups.

If you want to allow moderators to mark users as automoderated, you can use the following configuration:

$wgAddGroups['moderator'][] = 'automoderated';
$wgRemoveGroups['moderator'][] = 'automoderated';

Compatibility with other extensions

1. Extension:Moderation should be enabled last in LocalSettings.php, because it aborts at least MultiContentSave hook.
2. Extension:Moderation fully supports Extension:CheckUser , meaning that if CheckUser extension is enabled, then any approved edit will have correct IP, user-agent and XFF saved in the checkuser tables.
3. Extension:Moderation is fully compatible with Extension:VisualEditor and Extension:MobileFrontend . Theoretically it should also work with other API-based editors.
4. Extension:StructuredDiscussions (also known as Flow) and Extension:CommentStreams will work, but edits in Flow/CommentStreams forums will bypass moderation.

   Moderation of Flow forums should be implemented in Extension:StructuredDiscussions itself. These forums use a non-text "content model", which is not supported by Moderation.

   CommentStreams extension misinterprets "edit was queued for moderation" as an error, which can only be fixed in Extension:CommentStreams itself.

5. Extensions that modify several slots of Multi-Content Revisions (not just the main slot, as MediaWiki itself does) are not yet supported. (currently very few extensions do)

See also

• Extension:ConfirmEdit - common CAPTCHA extension.
• Extension:AbuseFilter - common extension against spam bots and typical vandalism like blanking.
• Content approval extensions