モジュール:Effective protection expiry/doc

提供: Millipedia
< モジュール:Effective protection expiry
2021年9月2日 (木) 23:06時点におけるja>ネイによる版 (en:Module:Effective protection expiry/doc oldid=989242125 より)
(差分) ← 古い版 | 最新版 (差分) | 新しい版 → (差分)
ナビゲーションに移動 検索に移動

このページは、モジュール:Effective protection expiryの説明文を記述するページです。

ページに対する特定操作の制限(いわゆる保護)の有効期限を取得するためのモジュールです。

使い方

このモジュールは呼び出される毎に高負荷パーサー関数を1回まで呼び出します。すでにモジュール:Effective protection levelを呼び出している場合は高負荷パーサー関数を呼び出しません。

ほかのモジュールからの利用

下記のようにモジュールを呼び出してください。 <syntaxhighlight lang="lua"> local effectiveProtectionExpiry = require('モジュール:Effective protection expiry')._main </syntaxhighlight>

この関数は引数を2つ使用します。第1引数はページに対する操作("edit"、"create"、"move"、"upload"、"autoreview"のどれか)を指定します。第2引数は操作を行うページ名を指定します。第2引数を省略した場合、モジュールが呼び出されたページのページ名が使用されます。

この関数の戻り値は有効期限のタイムスタンプ(書式:YY-MM-DDThh:mm:ss)の文字列です。ただし、下記の例外があります。

  • infinity - 無期限保護の場合か、保護されていないページ(ページが存在する場合)
  • unknown - 有効期限が不明な場合、保護されていないページ(ページが存在しない場合)

ページが存在し、かつ保護されていない場合はinfinityを返すので、一般的には保護レベルを調べるモジュール:Effective protection levelと併用します。

ウィキテキストからの利用

下記のように呼び出します。引数はモジュールから呼び出す場合と同じです。

関連項目