|This page documents an English Wikipedia guideline. It is a generally accepted standard that editors should follow, though it should be treated with common sense, and occasional exceptions may apply. Changes made to it should reflect consensus; when in doubt, discuss your idea on the talk page.|
The Edit filter is a tool that allows trusted editors in the edit filter manager group to set controls mainly to address common patterns of harmful editing. It automatically compares every edit made to Wikipedia against sets of conditions that are defined in user-created filters. If an edit matches the conditions of a filter, that filter will respond by logging the edit. It may also tag the edit summary, warn the editor, revoke his/her autoconfirmed status, and/or disallow the edit entirely.
The AbuseFilter extension was enabled on the English Wikipedia in 2009. The term "edit filter" rather than "abuse filter" is currently used for user-facing elements of the filter as some of the edits it flags are not harmful; the terms are otherwise synonymous.
Because even the smallest mistake in editing a filter can disrupt the encyclopedia, only editors who have the required good judgement and technical proficiency are permitted to configure filters. This page does not discuss technical issues concerning the feature; technical information relating to the operation of the edit filter can be found at Extension:AbuseFilter.
There are currently 168 edit filter managers.
Basics of usage
Edit filters are mainly used to identify and mitigate harmful edits by comparing edits with filtering criteria that address patterns of harmful editing. Filters are created and configured by edit filter managers, but they can be requested by any editor.
When an edit being saved "triggers" an active filter, the effect depends on a setting associated with that particular filter:
- The strongest setting is disallow. In this case, the edit is rejected, and the user will see this. (A link is provided for reporting false positives.) It is also possible to have a user's autoconfirmed status revoked if a user trips the filter.
- The next lowest setting is to warn. In this case, the user will see a customisable message that the edit may be problematic. The user then has the option to either proceed with the save or abandon the edit.
- The next lowest setting is to add a tag. In this case, the edit is tagged for review by patrollers.
- The lowest setting is to log the edit. In this case, the edit is merely added to this. When testing new filters, this is the suggested setting to use.
Except in urgent situations, new edit filters should generally be tested without any actions specified (simply enabled) until a good number of edits have been logged and checked before being implemented in "warn" or "disallow" modes. If the filter is receiving more than a very small percentage of false positives it should usually not be placed in 'disallow' mode. If a filter is designed to catch good faith edits it should not be placed in disallow mode without an appropriate consensus.
Edit filter managers should be familiar with alternatives that might be more appropriate in a given situation. For example, problems on a single page might be better served with page protection, and problems with page titles or link spam may find the title blacklist and spam blacklist more effective respectively. Because edit filters check every edit in some way, filters that are tripped only rarely are discouraged.
Edit filters should only be set to disallow to prevent edits that substantially all good-faith editors would agree are undesirable, or where a clear consensus has been reached that a specific type of edit should not be allowed. Any doubts regarding setting a filter to disallow should be discussed with other edit filter managers.
Only members of the edit filter manager group are allowed to modify filters, though all administrators can view private filters. Edit filter managers also have the ability to edit tags. This group is assignable by administrators, who may also assign the right to themselves.
The assignment of the edit filter manager user right to non-admins is highly restricted. It should only be requested by and given to highly trusted users; when there is a clear, demonstrated need for it. Demonstrated ability that one can and will use it safely is absolutely critical. This is because widespread disruption of the entire encyclopedia can easily occur—even unintentionally—with the smallest of mistakes in changing edit filters. Therefore, demonstrated knowledge of the extension's syntax and in understanding and crafting regular expressions is absolutely essential. Editors that are not edit filter managers should consider helping out at requested edit filters and troubleshooting at false positives to help demonstrate these skills.
Requests for assignment of the group to non-admins can be made at the edit filter noticeboard, where a discussion will be held before a decision is made. In addition a small number of WMF staff have the right, which they may request from the Trust and Safety group, following WMF procedures.
If an edit filter manager is misusing the user right, the concern should first be raised with them directly. If discussion does not resolve the issue, a request for discussion or removal of the user right may be made at the edit filter noticeboard.
Have a strong password
If you have the edit filter manager user right, please ensure you have a strong password and follow appropriate personal security practices. Because edit filters affect every edit made, a compromised account will be blocked and its privileges removed on grounds of site security. In the unlikely event that your account is compromised, notify an administrator or bureaucrat (for administrators) immediately so they can block your account and remove any sensitive privileges to prevent damage.
Requesting edit filters
Edit filters can be requested at the requests page. Edit filter managers monitor this page and implement edit filters when a good case is made. If there is disagreement WP:CONSENSUS applies. The desirability of an edit filter may also emerge from discussions elsewhere on Wikipedia or through communication on the mailing list.
If it would not be desirable to discuss the need for a given edit filter on-wiki, such as where the purpose of the filter is to combat harassment by an abusive banned user who is likely to come across the details of the request, edit filter managers can be emailed directly or on the wikipedia-en-editfilters mailing list at wikipedia-en-editfilterslists.wikimedia.org.
If an editor (who need not be an edit filter manager) believes that an existing edit filter is unnecessary, is preventing good edits, or is otherwise problematic, they should raise their concerns on the edit filter noticeboard or directly with the edit filter manager who created or enabled the filter for further discussion.
While filter settings and logs are by default publicly viewable, some are set to be private. For all filters, including those hidden from public view, a brief description of what the rule targets is displayed in the log, the list of active filters, and in any error messages generated by the filter. Edit filter managers should take care not to discuss the specifics of hidden filters publicly.
Filters should only be hidden where necessary, such as in long-term abuse cases where the targeted user(s) could review a public filter and use that knowledge to circumvent it. Filters should not generally be named after abusive editors, but rather with a simple description of the type of abuse, provided not too much information is given away.
Filter managers may share the contents of private edit filters with non-administrators on the basis of their good judgement. Be careful not to test sensitive parts of private filters in a public test filter (such as Filter 1): use a private test filter (for example Filter 2) if testing is required. Similarly be careful not to post sensitive parts of private filters on talk pages or persistent pages of external sites.
Sensitive issues concerning private filters may be raised by emailing filter managers or by contacting them via the wikipedia-en-editfilters mailing list at wikipedia-en-editfilterslists.wikimedia.org.
The mailing list wikipedia-en-editfilters is a private list in which only administrators and edit filter managers are subscribers. The list's primary function is for discussion of private filters, both between edit filter managers and with non-admins, who can email the list at wikipedia-en-editfilterslists.wikimedia.org. The mailing list should not be used as a venue for discussions which could reasonably be held on-wiki.
Tools and resources
Edit filters sometimes make use of relatively large (though not usually complex) regular expressions (regexes). External tools such as Debuggex can be useful for testing these. Because regexes are extremely fragile and almost any typo in one will cause it to malfunction, use of such a tool is recommended.
- Edit filters can and have been used to track or tag certain non-harmful edits, for example addition of WikiLove.
- The extension also allows for temporary blocking, but these features are disabled on the English Wikipedia.
- The extension uses Perl-style regular expressions, which is the most common style, but is substantially different from and more extensive than Scribunto (Lua) patterns. See this page for documentation.
- Be sure to set such tools to its "Perl" or "PCRE" (Perl Compatible Regular Expressions) mode; avoid using a tool if it doesn't have such a mode. Also this will not be useful with "ccnorm" strings.