Module:Effective protection expiry/doc: Difference between revisions

Revision as of 07:29, 17 February 2023

Latest revision as of 21:12, 29 August 2024

(3 intermediate revisions by 3 users not shown)

Line 1:

{{Module rating |protected <!-- Values: pre-alpha • alpha • beta • release • protected -- If a rating not needed/relevant, delete this template call -->}}

{{High-use}}

<!-- 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 ==

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 ===

Line 13 ⟶ 14:

</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 returnwreturned from the mw.title functions. If the secsecond parameter is omitted, the page being displayed is the one checked against.

* <code>infinity</code> - for pages protected indefinith do not exist and are n

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 indefinithindefinitely, door notpages which exist and are nnot protected

* <code>unknown</code> - for pages where the expiry is unknown, or pages which do not exist and are not protected

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

Line 26 ⟶ 31:

<!-- Categories below this line, please; interwikis at Wikidata -->

}}</includeonly><noinclude>

[[Category:Module documentation pages]]

</noinclude>