Difference between revisions of "Module:Effective protection expiry/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Cenarium
(add)
 
m (9 revisions imported)
 
(8 intermediate revisions by 5 users not shown)
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 |protected <!-- 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 6: Line 9:
 
=== From other modules ===
 
=== From other modules ===
 
To load this module:
 
To load this module:
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
local effectiveProtectionExpiry = require('Module:Effective protection expiry')._main
 
local effectiveProtectionExpiry = require('Module:Effective protection expiry')._main
</source>
+
</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 either a date string in <code>YY-MM-DDThh:mm:ss</code> format, or one of the following strings:
 +
* <code>infinity</code> - for pages protected indefinitely
 +
* <code>unknown</code> - for pages which are not protected or where the expiry is unknown
  
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.
+
Note that if the page is not protected for the requested action, this will return 'infinity'. You need to check separately with [[Module:Effective protection level]].
  
 
=== From wikitext ===
 
=== From wikitext ===
Line 16: Line 25:
 
  {{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>

Latest revision as of 11:17, 22 September 2020

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 either a date string in YY-MM-DDThh:mm:ss format, or one of the following strings:

  • infinity - for pages protected indefinitely
  • unknown - for pages which are not protected or where the expiry is unknown

Note that if the page is not protected for the requested action, this will return 'infinity'. You need to check separately with Module:Effective protection level.

From wikitext

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

Template:Tlinv

See also