Jump to content

Extension:Report

From mediawiki.org
MediaWiki extensions manual
Report
Release status: beta
Implementation Special page , Database
Description Allows users to privately report revisions
Author(s) Ken Hilton (Kenny2wikitalk)
Compatibility policy Master maintains backward compatibility.
MediaWiki 1.35+
PHP >= 5.6
Database changes Yes
Tables report_reports
License GNU General Public License 3.0
Download
Help Help:Extension:Report
  • report
  • handle-reports
Quarterly downloads 6 (Ranked 123rd)
Translate the Report extension if it is available at translatewiki.net

The Report extension adds a special page for users to privately report revisions of pages for admin attention, as well as another special page for admins to handle such reports.

Warning Warning: This extension is currently incompatible with temporary accounts.
Temporary accounts can be disabled with $wgAutoCreateTempUser['enabled'] = false; in your LocalSettings.php.

Installation

[edit]
  • Download and move the extracted Report 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/Report
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'Report' );
    
  • Run the update script which will automatically create the necessary database tables that this extension needs.
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Optional configuration

[edit]

By default, only registered users can report revisions, and only sysops can handle reports:

// These are the default settings for the extension, no need to manually set it
$wgGroupPermissions['user']['report'] = true;
$wgGroupPermissions['sysop']['handle-reports'] = true;

If different permissions are required, simply adjust $wgGroupPermissions. For example, to allow unregistered users to report revisions, and only allow bureaucrats to handle reports, add the following to LocalSettings.php, after loading the extension:

$wgGroupPermissions['*']['report'] = true;
$wgGroupPermissions['sysop']['handle-reports'] = false;
$wgGroupPermissions['bureaucrat']['handle-reports'] = true;

Usage

[edit]

Reporting

[edit]
  1. Go to the history of a page, or look at a diff between revisions.
  2. Click the "report" link (next to undo).
  3. Enter a reason for reporting the revision.
  4. Submit the report.

Handling reports

[edit]
  1. As an admin (or other user with the handle-reports permission), browse to Special:HandleReports.
  2. You will be presented with a list of recent reports. Choose a report that catches your attention by clicking "View report".
  3. On the "view report" page, you will be presented with a single button to mark the report as handled. After making sure that any required action for the report has been taken care of, click "Mark as handled".

Known issues

[edit]
  • After a report has been marked as handled, other admins can still re-mark it as handled. This only changes the who and when of the report being handled, however.

See also

[edit]