Modul:Effective protection level/doc

This is a documentation subpage for Modul:Effective protection level.
It contains usage information, categories and other content that is not part of the original modul page.

This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing.

This module provides a way to retrieve the group required to perform a given action on a page. It currently tests the following criteria:

The page being pending-changes protected: reviewer or autoconfirmed
The page being in the MediaWiki namespace: sysop
The page being a JavaScript or CSS subpage in userspace: sysop
The page being protected: sysop, templateeditor, or autoconfirmed
The page being used in a cascading-protected page: sysop
The page's title matching the titleblacklist: accountcreator or autoconfirmed
A file being moved: filemover
A page being moved or a file being uploaded: autoconfirmed
A non-Draft non-talk page being created: user
Anything else: *

Note that if a template-protected file is moved, both filemover and templateeditor are required, but this will return only templateeditor. This is not likely to be changed any time soon, since template protection currently shouldn't be used on files.

Usage

From other modules

To load this module:

local effectiveProtectionLevel = require('Module:Effective protection level')._main

The function accepts two parameters. The first is a string containing the action to check, which must be one of "edit", "create", "move", "upload", or "autoreview". The second is optional, and can either be the name of the page to check, or a title returned from the mw.title functions. If the second parameter is omitted, the page being displayed is the one checked against. The return value is a string containing the name of the group required to perform the given action.

From wikitext

The parameters are the same as when it is called directly.

{{#invoke:Effective protection level|action|title}}