モジュール:Effective protection expiry/doc
表示
これはモジュール:Effective protection expiryの解説サブページです。 使用方法、カテゴリ、およびその他モジュールページ自体に含まれない情報を収容しています。 |
ページに対する特定操作の制限(いわゆる保護)の有効期限を取得するためのモジュールです。
使い方
[編集]このモジュールは呼び出される毎に高負荷パーサー関数を1回まで呼び出します。すでにモジュール:Effective protection levelを呼び出している場合は高負荷パーサー関数を呼び出しません。
ほかのモジュールからの利用
[編集]下記のようにモジュールを呼び出してください。
local effectiveProtectionExpiry = require('モジュール:Effective protection expiry')._main
この関数は引数を2つ使用します。第1引数はページに対する操作("edit"、"create"、"move"、"upload"、"autoreview"のどれか)を指定します。第2引数は操作を行うページ名を指定します。第2引数を省略した場合、モジュールが呼び出されたページのページ名が使用されます。
この関数の戻り値は有効期限のタイムスタンプ(書式:YY-MM-DDThh:mm:ss
)の文字列です。ただし、下記の例外があります。
infinity
- 無期限保護の場合か、保護されていないページ(ページが存在する場合)unknown
- 有効期限が不明な場合、保護されていないページ(ページが存在しない場合)
ページが存在し、かつ保護されていない場合はinfinity
を返すので、一般的には保護レベルを調べるモジュール:Effective protection levelと併用します。
ウィキテキストからの利用
[編集]下記のように呼び出します。引数はモジュールから呼び出す場合と同じです。
{{#invoke:Effective protection expiry|操作|ページ名}}