Module:Effective protection expiry/doc: Difference between revisions

Revision as of 22:08, 10 December 2015

Latest revision as of 21:12, 29 August 2024

(20 intermediate revisions by 15 users not shown)

Line 1:

{{Module rating |alphaprotected <!-- 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]]) -->

Line 9 ⟶ 10:

=== From other modules ===

To load this module:

<sourcesyntaxhighlight lang="lua">

local effectiveProtectionExpiry = require('Module:Effective protection expiry')._main

</syntaxhighlight>

</source>

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.

The return value is either a date string in <code>YY-MM-DDThh:mm:ss</code> format, or one of the following strings:

It is not yet possible to retrieve the expiry for pending changes protection ("autoreview" action), so it returns 'unknown' in that case.

* <code>infinity</code> - for pages protected indefinitely, or pages which exist and are not 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]].

=== From wikitext ===

Line 26 ⟶ 31:

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

}}</includeonly><noinclude>

[[Category:Module documentation pages]]

</noinclude>