Module:Effective protection expiry/doc
This is the documentation page for Module:Effective protection expiry
 | This {{<tvar|1>#switch:Module|File</>=Image|page}} is a candidate for deletion. The given reason is: Only used by other pages I've nominated for deletion
If discussion is still ongoing, it should remain until a consensus is reached, after which the page will either be deleted or this notice removed. If you disagree with its deletion, please discuss your reasons on this page or on its associated talk page, as applicable. Remember to check [[<tvar|1>Special:Whatlinkshere/Module:Effective protection expiry/doc</>|if anything links here]] and [<tvar |
 | This module is rated as ready for general use. It has reached a mature form and is thought to be bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing. |
This module provides a way to retrieve the expiry of a restriction over a given action on a page.
UsageEdit
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 modulesEdit
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", 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 either a date string in YY-MM-DDThh:mm:ss format, or one of the following strings:
infinity- for pages protected indefinitelyunknown- 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 wikitextEdit
The parameters are the same as when it is called directly.
{{#invoke:Effective protection expiry|action|title}}