Module:Effective protection level/doc: Difference between revisions
Created page with "{{Module rating|protected}} {{cascade-protected template|page=module}} {{used in system}} 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: autoconfirmed * The page being a JavaScript or CSS subpage in userspace, or in the MediaWiki namespace: interfaceadmin * The page being in the MediaWiki namespace: sysop * The page being a JSON subpage..." |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Module rating| | {{Module rating|release}} | ||
This module provides a way to retrieve the group required to perform a given action on a page. It currently tests the following criteria: | 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 in the MediaWiki namespace: sysop | ||
* The page being a JavaScript or CSS subpage in userspace: interfaceadmin | |||
* The page being a JSON subpage in userspace: sysop | * The page being a JSON subpage in userspace: sysop | ||
* The page being protected: sysop | * The page being protected: sysop or autoconfirmed | ||
* The page being used in a cascading-protected page: sysop | * The page being used in a cascading-protected page: sysop | ||
* The page's title matching the titleblacklist: | * The page's title matching the titleblacklist: sysop or autoconfirmed | ||
* A file being moved: | * A file being moved: sysop | ||
* A page being moved | * A page being moved: autoconfirmed | ||
* A | * A file being uploaded: uploader | ||
* Anything else: * | * Anything else: * | ||
== Usage == | == Usage == | ||
| Line 26: | Line 22: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
The function accepts two parameters. The first is a string containing the action to check, which must be one of "edit", "create", "move", "upload | 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 === | === From wikitext === | ||
The parameters are the same as when it is called directly. | The parameters are the same as when it is called directly. | ||
{{ | {{<nowiki/>#invoke:Effective protection level|''action''|''title''}} | ||
== See also == | == See also == | ||
* [[Module:Effective protection expiry]] | * [[Module:Effective protection expiry]] | ||
Latest revision as of 16:53, 11 January 2026
 | <translate> This module is rated as [[<tvar name=1>Special:MyLanguage/Category:Modules for general use</tvar>|ready for general use]].</translate> <translate> It has reached a mature form and is thought to be bug-free and ready for use wherever appropriate.</translate> <translate> It is ready to mention on help pages and other resources as an option for new users to learn.</translate> <translate> To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.</translate> |
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 JavaScript or CSS subpage in userspace: interfaceadmin
- The page being a JSON subpage in userspace: sysop
- The page being protected: sysop or autoconfirmed
- The page being used in a cascading-protected page: sysop
- The page's title matching the titleblacklist: sysop or autoconfirmed
- A file being moved: sysop
- A page being moved: autoconfirmed
- A file being uploaded: uploader
- Anything else: *
Usage
Warning: This module will use up to 4 expensive parser function calls each time it is ran. It should only be used if the exact effective protection level is necessary. Otherwise, consider using title.protectionLevels instead.
From other modules
To load this module: <syntaxhighlight lang="lua"> local effectiveProtectionLevel = require('Module:Effective protection level')._main </syntaxhighlight>
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}}