Difference between revisions of "Module:Effective protection expiry/doc"
blackwiki>Cenarium (add) |
blackwiki>Cenarium |
||
| Line 1: | Line 1: | ||
{{Module rating |alpha<!-- Values: pre-alpha • alpha • beta • release • protected -- If a rating not needed/relevant, delete this template call -->}} | {{Module rating |alpha<!-- Values: pre-alpha • alpha • beta • release • protected -- If a rating not needed/relevant, delete this template call -->}} | ||
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --> | <!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --> | ||
| + | |||
| + | This module provides a way to retrieve the expiry of a restriction over a given action on a page. | ||
| + | |||
== Usage == | == Usage == | ||
This module will use up to 1 expensive parser function call each time it is ran. It will not use any if [[Module:Effective protection level]] was already called. | This module will use up to 1 expensive parser function call each time it is ran. It will not use any if [[Module:Effective protection level]] was already called. | ||
| Line 16: | Line 19: | ||
{{tlinv|Effective protection expiry|''action''|''title''}} | {{tlinv|Effective protection expiry|''action''|''title''}} | ||
| + | == See also == | ||
| + | * [[Module:Effective protection level]] | ||
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | | ||
<!-- Categories below this line, please; interwikis at Wikidata --> | <!-- Categories below this line, please; interwikis at Wikidata --> | ||
}}</includeonly> | }}</includeonly> | ||
Revision as of 21:46, 10 December 2015
| 26x26px | 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 expiry of a restriction over a given action on a page.
Usage
This module will use up to 1 expensive parser function call each time it is ran. It will not use any if Module:Effective protection level was already called.
From other modules
To load this module:
local effectiveProtectionExpiry = require('Module:Effective protection expiry')._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.
Template:Tlinv