Module:Effective protection level/doc

This module is rated as alpha. It is ready for third-party input, and may be used on a few pages to see if problems arise, but should be watched. Suggestions for new features or changes in their input and output mechanisms are welcome.

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 in the MediaWiki namespace: sysop
• The page being a userspace .js or .css: sysop
• The page being protected: the relevant protection level
• The page being used in a cascading-protected page: sysop
• 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: *

The following criteria are currently not testable, due to lack of support in MediaWiki:

• The page's title matching the titleblacklist: tboverride or autoconfirmed
• The page having Pending Changes enabled: autoconfirmed or reviewer

Note that if a template-protected file is moved, both filemover and templateeditor are required, but this will return only filemover. 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", or "upload". 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

Template:Effective protection level provides a wrapper around this module, allowing it to be used from wikitext. The parameters are the same as when it is called directly.

{{Effective protection level|action|title}}
{{Effective protection level|action=action|title=title}}