Help:Extension:ParserFunctions

From mediawiki.org
Jump to navigation Jump to search
This page is a translated version of the page Help:Extension:ParserFunctions and the translation is 52% complete.
Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Lëtzebuergesch • ‎Nederlands • ‎Tiếng Việt • ‎Türkçe • ‎Zazaki • ‎español • ‎français • ‎galego • ‎italiano • ‎magyar • ‎polski • ‎português • ‎português do Brasil • ‎slovenščina • ‎suomi • ‎svenska • ‎čeština • ‎български • ‎русский • ‎українська • ‎հայերեն • ‎العربية • ‎فارسی • ‎پښتو • ‎मराठी • ‎বাংলা • ‎தமிழ் • ‎ไทย • ‎中文 • ‎日本語 • ‎한국어

ParserFunctions 拡張機能は「マジックワード 」を補完する MediaWiki に既存の11のパーサ関数を提供します。 (文字列処理のために追加のパーサー関数を提供するように設定できるかもしれません。ここでいう文字列関数の説明文書はこちら を参照してください。) この拡張機能が提供するすべてのパーサー関数は以下の形式です:

{{#関数名: 引数 1 | 引数 2 | 引数 3 ... }}

#expr

種類 演算子
グループ化 (括弧) ( )
数値 1234.5   e (2.718)   pi (3.142)
二項演算子 e   単項 +,-
単項 not ceil trunc floor abs exp ln sin cos tan acos asin atan
二項 ^
* / div mod
+ -
丸め round
論理 = != <> > < >= <=
and
or

この関数は、数式を計算してその計算結果を返します。 この関数はmw.ext.ParserFunctions.expr 関数を介して Scribunto でも使えます。

{{#expr: 数式 }}

表の右欄は使用できる演算子で、上ほど優先順位が高いものです。各演算子の機能の詳細は計算のヘルプ ヘルプ:Calculation を参照してください。出力結果の精度と形式には幅があり、ウィキを実行するサーバーのOSバージョン、サイト表示言語の数値形式の影響を受けます。

ブール代数を使用して評価する際、値がゼロならfalse、非ゼロなら正の数でも負の数でもtrueと評価されます:

{{#expr: 1 and -1 }}1
{{#expr: 1 and 0 }}0
{{#expr: 1 or -1 }}1
{{#expr: -1 or 0 }}1
{{#expr: 0 or 0 }}0

空の入力式は空の文字列を返します。無効な式はいくつかのエラー メッセージのうちのいずれかを返します。このエラーは #iferror 関数を使用して捕捉できます:

{{#expr: }}
{{#expr: 1+ }}Expression error: Missing operand for +.
{{#expr: 1 = }}Expression error: Missing operand for =.
{{#expr: 1 foo 2 }}Expression error: Unrecognized word "foo".

The order of addition and subtraction operands before or after a number is meaningful and may be treated as a positive or negative value instead of as an operand with an erroneous input:

{{#expr: +1 }}1
{{#expr: -1 }}-1
{{#expr: + 1 }}1
{{#expr: - 1 }}-1

Note, if using the output of magic words, you must raw-format them in order to remove commas and translate the numerals. For example, {{NUMBEROFUSERS}} results in 17,389,443, where we want 17389443, which can be obtained using {{formatnum :{{NUMBEROFUSERS}}|R}}. This is especially important in some languages, where numerals are translated. For example, in Bengali, {{NUMBEROFUSERS}} produces ৩০,০৬১.

{{#expr:{{NUMBEROFUSERS}}+100}} Expression error: Unrecognized punctuation character ",".
{{#expr:{{formatnum:{{NUMBEROFUSERS}}|R}}+100}}17389543
警告 警告: 演算子 mod は、第 2 引数の値によっては誤った結果を返す場合があります:
{{#expr: 123 mod (2^64-1)}}Division by zero. (空の文字列を返しますが、123 を返すべきです)
If you want to do calculations based on dates (ex. test whether current date and time is after some other date and time), first convert the time to number of seconds after January 1, 1970 using {{#time: xNU }}, then you can simply add and subtract dates as numbers.

丸め

Rounds off the number on the left to a multiple of 1/10 raised to a power, with the exponent equal to the truncated value of the number given on the right.

切り上げや切り捨てを行なうには、それぞれ単項の ceilfloor を使用してください。

結果 丸めの手法
{{#expr: 1/3 round 5 }} 0.33333 最終桁が 5 未満であるため、切り上げはされません
{{#expr: 1/6 round 5 }} 0.16667 最終桁が 5 以上であるため、切り上げされます
{{#expr: 8.99999/9 round 5 }} 1 Again, the result is rounded up on the last digit, which results in additional rounding
{{#expr: 1234.5678 round -2 }} 1200 Rounded to nearest 100 because negative values round to the left of the decimal point
{{#expr: 1234.5678 round 2 }} 1234.57 Rounded to nearest 100th because positive values round to the right of the decimal point
{{#expr: 1234.5678 round 2.3 }} 1234.57 round の右の値の小数点以下は、丸めの結果には影響しません
{{#expr: trunc 1234.5678 }} 1234 小数点以下の切り捨て
最も近い整数への丸め
{{#expr: 1/3 round 0 }} 0 最も近い整数への切り捨てで 0
{{#expr: 1/2 round 0 }} 1 最も近い整数への切り上げで 1
{{#expr: 3/4 round 0 }} 1 最も近い整数への切り上げで 1
{{#expr: -1/3 round 0 }} -0 最も近い整数への切り上げで 0
{{#expr: -1/2 round 0 }} -1 最も近い整数への切り捨てで -1
{{#expr: -3/4 round 0 }} -1 最も近い整数への切り捨てで -1
ceillfloor による切り上げや切り捨て
{{#expr: ceil(1/3) }} 1 次に大きい整数まで
{{#expr: floor(1/3) }} 0 Down to the next smaller integer, which is zero
{{#expr: ceil(-1/3) }} -0 Up to the next larger integer, which is zero
{{#expr: floor(-1/3) }} -1 Down to the next smaller integer, which is negative one
{{#expr: ceil 1/3 }} 0.33333333333333 1 が既に整数であるため、丸めは行なわれない
警告 警告: あなたの予想とは異なり、ceil(1/3) ではなく (ceil 1)/3 と解釈される

文字列

Expressions only work with number-like values, they cannot compare strings or characters. #ifeq can be used instead.

{{#expr: "a" = "a" }}Expression error: Unrecognized punctuation character """.
{{#expr: a = a }}Expression error: Unrecognized word "a".
{{#ifeq: a | a | 1 | 0 }}1

#if

この関数はテスト文字列を評価し、それが空であるかどうかを判定します。空白のみを含むテスト文字列は空であると見做されます。

{{#if: テスト文字列 | テスト文字列が空ではない場合の値 | テスト文字列が空 (または空白のみ) の場合の値 }}
{{#if: パラメーター 1 | パラメーター 2 | パラメーター 3 }}

この関数は、初めに最初の引数が空でないか確かめます。最初の引数が空でない場合、2 番目の引数を表示します。最初の引数が空または空白文字(空白、改行等)のみを含む場合、3 番目の引数を表示します。

{{#if: | yes | no}}no
{{#if: string | yes | no}}yes
{{#if:      | yes | no}}no
{{#if:


| yes | no}}
no

テスト文字列は常に純粋なテキストとして評価されます。そのため数式は評価されません:

{{#if: 1==2 | yes | no }}yes
{{#if: 0 | yes | no }}yes

最後の引数(偽)は省略可能です:

{{#if: foo | yes }} yes
{{#if: | yes }}
{{#if: foo | | no}}

The function may be nested. To do so, nest the inner #if function in its full form in place of a parameter of the enclosing #if function. Up to seven levels of nesting is possible, although that may depend on the wiki or a memory limit.

{{#if: test string | value if test string is not empty | {{#if: test string | value if test string is not empty | value if test string is empty (or only white space) }} }}
  1. if 文において引数をテスト文字列として用いることも可能です。変数名の後には |(パイプ記号)を追加する必要があります。

(So that if the parameter does not have a value, it evaluates to an empty string instead of the string "{{{1}}}".)

{{#if:{{{1|}}}|You entered text in variable 1|There is no text in variable 1 }}

このパーサー関数の他の例については Help:テンプレート内でのパーサー関数 を参照してください。

#ifeq

This parser function compares two input strings, determines whether they are identical, and returns one of two strings based on the result. If more comparisons and output strings are required, consider using #switch.

{{#ifeq: string 1 | string 2 | value if identical | value if different }}

If both strings are valid numerical values, the strings are compared numerically:

{{#ifeq: 01 | 1 | equal | not equal}}equal
{{#ifeq: 0 | -0 | equal | not equal}}equal
{{#ifeq: 1e3 | 1000 | equal | not equal}}equal
{{#ifeq: {{#expr:10^3}} | 1000 | equal | not equal}}equal

それ以外は文字列として比較します。その場合は大文字小文字を識別します。

{{#ifeq: foo | bar | equal | not equal}}not equal
{{#ifeq: foo | Foo | equal | not equal}}not equal
{{#ifeq: "01" | "1" | equal | not equal}}not equal  (compare to similar example above, without the quotes)
{{#ifeq: 10^3 | 1000 | equal | not equal}}not equal  (compare to similar example above, with #expr returning a valid number first)

As a practical example, consider an existing template Template:Timer using the parser to choose between two standard times, short and long. It takes the parameter as the first input to compare against the string "short" – there is no convention for the order, but it is simpler to read if the parameter goes first. The template code is defined as:

{{#ifeq: {{{1|}}} | short | 20 | 40 }}

the following ensue:

{{timer|short}}20
{{timer|20}}40
{{timer}}40
警告 警告: #ifexpr does not report equivalent numerical comparisons with the #ifeq and #switch parsers. These latter two are more accurate than #ifexpr, and do not return equivalent results.

Consider these comparison with the final digit changed:

{{#ifeq: 12345678901234567 | 12345678901234568 | equal | not equal}}not equal
{{#switch: 12345678901234567 | 12345678901234568 = equal | not equal}}not equal

Because PHP used in #ifeq and #switch compares two numbers of type integer, it returns the expected result correctly. Whereas with #ifexpr and the same numbers:

{{#ifexpr: 12345678901234567 = 12345678901234568 | equal | not equal}}equal

With the different digit, the result of equal is actually incorrect.

This behaviour in #ifexpr is caused because MediaWiki converts literal numbers in expressions to type float, which, for large integers like these, involves rounding.

警告 警告: When used inside a parser function, any parser tags and other parser functions must be temporarily replaced with a unique code . This affects comparisons:
{{#ifeq: <nowiki>foo</nowiki> | <nowiki>foo</nowiki> | equal | not equal}}not equal
{{#ifeq: <math>foo</math> | <math>foo</math> | equal | not equal}}not equal
{{#ifeq: {{#tag:math|foo}} | {{#tag:math|foo}} | equal | not equal}}not equal
{{#ifeq: [[foo]] | [[foo]] | equal | not equal}}equal
比較するどの文字列も、そのタグを含む同じテンプレート を呼び出す場合は真、そのタグを含み内容が同じだが別々のテンプレートを呼び出す場合は偽。
警告 警告: Literal comparisons to page-name magic words may fail depending on site configuration.

For example, {{FULLPAGENAME}}, depending on wiki, may capitalize the first letter, and will replace all underscores with spaces.

To work around this, apply the magic word to both parameters:

{{#ifeq: {{FULLPAGENAME: L'Aquila}} | {{FULLPAGENAME}} | equal | not equal}}equal

#iferror

この関数は入力文字列を取り、2つの結果から1つを返します。この関数は、 #expr#time#rel2abs のような他のパーサー関数、ループや再帰のようなテンプレートエラー、その他の「フェースソフト」なパーサーエラーによって作られた class="error" を含む HTML オブジェクトが入力文字列に含まれていた場合に true と評価します。

{{#iferror: test string | value if error | value if correct }}

返値の文字列の一方または両方が省略できます。もし correct の文字列が省略されていた場合、エラーがないのであれば test string が返されます。 error の文字列も省略されていた場合は、エラー時にから文字列が返されます。

{{#iferror: {{#expr: 1 + 2 }} | error | correct }}correct
{{#iferror: {{#expr: 1 + X }} | error | correct }}error
{{#iferror: {{#expr: 1 + 2 }} | error }}3
{{#iferror: {{#expr: 1 + X }} | error }}error
{{#iferror: {{#expr: 1 + 2 }} }}3
{{#iferror: {{#expr: 1 + X }} }}
{{#iferror: {{#expr: . }} | error | correct }}correct
{{#iferror: <strong class="error">a</strong> | error | correct }}error

#ifexpr

This function evaluates a mathematical expression and returns one of two strings depending on the boolean value of the result:

{{#ifexpr: expression | value if true | value if false }}

The expression input is evaluated exactly as for #expr above, with the same operators being available. The output is then evaluated as a boolean expression.

An empty input expression evaluates to false:

{{#ifexpr: | yes | no}}no

As mentioned above, zero evaluates to false and any nonzero value evaluates to true, so this function is equivalent to one using #ifeq and #expr only:

{{#ifeq: {{#expr: expression }} | 0 | value if false | value if true }}

except for an empty or wrong input expression (an error message is treated as an empty string; it is not equal to zero, so we get value if true).

{{#ifexpr: = | yes | no }} Expression error: Unexpected = operator.

comparing

{{#ifeq: {{#expr: = }} | 0 | no | yes }} yes

Either or both the return values may be omitted; no output is given when the appropriate branch is left empty:

{{#ifexpr: 1 > 0 | yes }}yes
{{#ifexpr: 1 < 0 | yes }}
{{#ifexpr: 0 = 0 | yes }} yes
{{#ifexpr: 1 > 0 | | no}}
{{#ifexpr: 1 < 0 | | no}} no
{{#ifexpr: 1 > 0 }}

#ifexist

This function takes an input string, interprets it as a page title, and returns one of two values depending on whether or not the page exists on the local wiki.

{{#ifexist: page title | value if exists | value if doesn't exist }}

The function evaluates to true if the page exists, whether it contains content, is visibly blank (contains meta-data such as category links or magic words , but no visible content), is blank, or is a redirect . Only pages that are redlinked evaluate to false, including if the page used to exist but has been deleted.

{{#ifexist: Help:Extension:ParserFunctions/ja | exists | doesn't exist }}exists
{{#ifexist: XXHelp:Extension:ParserFunctions/jaXX | exists | doesn't exist }}doesn't exist

The function evaluates to true for system messages that have been customized, and for special pages that are defined by the software.

{{#ifexist: Special:Watchlist | exists | doesn't exist }}exists
{{#ifexist: Special:CheckUser | exists | doesn't exist }}exists (because the Checkuser extension is installed on this wiki)
{{#ifexist: MediaWiki:Copyright | exists | doesn't exist }}exists (because MediaWiki:Copyright has been customized)

If a page checks a target using #ifexist:, then that page will appear in the Special:WhatLinksHere list for the target page. So if the code {{#ifexist:Foo }} were included live on this page (Help:Extension:ParserFunctions/ja), Special:WhatLinksHere/Foo will list Help:Extension:ParserFunctions/ja.

On wikis using a shared media repository, #ifexist: can be used to check if a file has been uploaded to the repository but not to the wiki itself:

{{#ifexist: File:Example.png | exists | doesn't exist }}doesn't exist
{{#ifexist: Image:Example.png | exists | doesn't exist }}doesn't exist
{{#ifexist: Media:Example.png | exists | doesn't exist }}exists

If a local description page has been created for the file, the result is exists for all of the above.

#ifexist: does not work with interwiki links.

ifexistの制限

#ifexist: is considered an "expensive parser function"; only a limited number of which can be included on any one page (including functions inside transcluded templates). When this limit is exceeded, any further #ifexist: functions automatically return false, whether the target page exists or not, and the page is categorized into Category:Pages with too many expensive parser function calls. The name of the tracking category may vary depending on the content language of your wiki.

使用事例によっては、a.new (存在しないページへのリンクを選択) またはa:not(.new) (存在するページへのリンクを選択) を使用して ifexist 効果を css で代用できます。さらに、単一ページで使用するメモリ消耗の激しいパーサ関数の件数の上限は $wgExpensiveParserFunctionLimit で制御され、必要な場合は上限値を LocalSettings.php で変更できます。

ifexist and wanted pages

A page that does not exist and is tested for using #ifexist will end up on the Wanted Pages.

#rel2abs

この関数は相対ファイル パスを絶対ファイル パスに変換します。

{{#rel2abs: path }}
{{#rel2abs: path | base path }}

path 部分では、以下の構文を使用できます:

  • . → 現在の階層
  • .. → 1 つ上の階層に移動
  • /foo → 下位ディレクトリ /foo に 1 階層移動

base path を指定していない場合は、ページの完全なページ名が代わりに使用されます:

{{#rel2abs: /quok | Help:Foo/bar/baz }}Help:Foo/bar/baz/quok
{{#rel2abs: ./quok | Help:Foo/bar/baz }}Help:Foo/bar/baz/quok
{{#rel2abs: ../quok | Help:Foo/bar/baz }}Help:Foo/bar/quok
{{#rel2abs: ../. | Help:Foo/bar/baz }}Help:Foo/bar

/././ のような無効な構文は無視されます。 Since no more than two consecutive full stops are permitted, sequences such as these can be used to separate successive statements:

{{#rel2abs: ../quok/. | Help:Foo/bar/baz }}Help:Foo/bar/quok
{{#rel2abs: ../../quok | Help:Foo/bar/baz }}Help:Foo/quok
{{#rel2abs: ../../../quok | Help:Foo/bar/baz }}quok
{{#rel2abs: ../../../../quok | Help:Foo/bar/baz }}Error: Invalid depth in path: "Help:Foo/bar/baz/../../../../quok" (tried to access a node above the root node).

#switch

See also : w:Help:Switch parser function

この関数は入力値1件を複数のテストケースと比較し、ヒットした場合は当該の文字列を返します。

{{#switch: comparison string
 | case = result
 | case = result
 | ...
 | case = result
 | default result
}}

例:

{{#switch: baz | foo = Foo | baz = Baz | Bar }} Baz
{{#switch: foo | foo = Foo | baz = Baz | Bar }} Foo
{{#switch: zzz | foo = Foo | baz = Baz | Bar }} Bar

#switch with partial transclusion tags can affect a configuration file that enables an editor unfamiliar with template coding to view and edit configurable elements.

既定

case文字列に対応するcomparison stringがヒットしない場合、default resultを返します。

{{#switch: test | foo = Foo | baz = Baz | Bar }} Bar

In this syntax, the default result must be the last parameter and must not contain a raw equals sign (an equals sign without {{}}). If it does, it will be treated as a case comparison, and no text will display if no cases match. This is because the default value has not been defined (is empty). If a case matches however, its associated string will be returned.

{{#switch: test | Bar | foo = Foo | baz = Baz }} →
{{#switch: test | foo = Foo | baz = Baz | B=ar }} →
{{#switch: test | test = Foo | baz = Baz | B=ar }} → Foo

代替方法として、既定の結果を "#default" のcase文字列で明示的に宣言することもできます。

{{#switch: comparison string
 | case = result
 | case = result
 | ...
 | case = result
 | #default = default result
}}

Default results declared in this way may be placed anywhere within the function:

{{#switch: test | foo = Foo | #default = Bar | baz = Baz }} Bar

If the default parameter is omitted and no match is made, no result is returned:

{{#switch: test | foo = Foo | baz = Baz }}

Grouping results

いくつかの case 文字列に同じ result 文字列を返す「フォールスルー」値を持たせることができます。これにより重複を最小限に抑えることができます。

{{#switch: comparison string
 | case1 = result1
 | case2 
 | case3 
 | case4 = result234
 | case5 = result5
 | case6 
 | case7 = result67
 | #default = default result
}}

ここではケース2と3、4とも出力はresult234です。ケース6と7の出力は両方ともresult67です The "#default = " in the last parameter may be omitted in the above case.

Use with parameters

The function may be used with parameters as the test string. In this case, it is not necessary to place the pipe after the parameter name, because it is very unlikely that you will choose to set a case to be the string "{{{parameter name}}}". (This is the value the parameter will default to if the pipe is absent and the parameter doesn't exist or have a value. Help:テンプレート内でのパーサー関数 を参照してください。)

{{#switch: {{{1}}} | foo = Foo | baz = Baz | Bar }}

In the above case, if {{{1}}} equals foo, the function will return Foo. If it equals baz, the function will return Baz. If the parameter is empty or does not exist, the function will return Bar.

As in the section above, cases can be combined to give a single result.

{{#switch: {{{1}}} | foo | zoo | roo = Foo | baz = Baz | Bar }}

Here, if {{{1}}} equals foo, zoo or roo, the function will return Foo. If it equals baz, the function will return Baz. If the parameter is empty or does not exist, the function will return Bar.

Additionally, the default result can be omitted if you do not wish to return anything if the test parameter value does not match any of the cases.

{{#switch: {{{1}}} | foo = Foo | bar = Bar }}

In this case, the function returns an empty string unless {{{1}}} exists and equals foo or bar, in which case it returns Foo or Bar, respectively.

This has the same effect as declaring the default result as empty.

{{#switch: {{{1}}} | foo | zoo | roo = Foo | baz = Baz | }}

If for some reason you decide to set a case as "{{{parameter name}}}", the function will return that case's result when the parameter doesn't exist or doesn't have a value. The parameter would have to exist and have a value other than the string "{{{parameter name}}}" to return the function's default result.

(when {{{1}}} doesn't exist or is empty):
{{#switch: {{{1}}} | {{{1}}} = Foo | baz = Baz | Bar }} Foo
(when {{{1}}} has the value "test"):
{{#switch: {{{1}}} | {{{1}}} = Foo | baz = Baz | Bar }} Bar
(when {{{1}}} has the value "{{{1}}}"):
{{#switch: {{{1}}} | {{{1}}} = Foo | baz = Baz | Bar }} Foo


In this hypothetical case, you would need to add the pipe to the parameter ({{{1|}}}).

比較の挙動

#ifeq 同様、比較は比較する文字列と対象の格文字列が数値である場合、数値として処理されます。あるいは大文字小文字を識別する文字列として処理されます。

{{#switch: 0 + 1 | 1 = one | 2 = two | three}} → three
{{#switch: {{#expr: 0 + 1}} | 1 = one | 2 = two | three}} → one
{{#switch: a | a = A | b = B | C}} → A
{{#switch: A | a = A | b = B | C}} → C

case文字列は空白の場合があります。

{{#switch: | = Nothing | foo = Foo | Something }}Nothing

一致が見つかると、それ以降のcasesは無視されます。

{{#switch: b | f = Foo | b = Bar | b = Baz | }}Bar
警告 警告:

Numerical comparisons with #switch and #ifeq are not equivalent to comparisons in expressions (see also above):

{{#switch: 12345678901234567 | 12345678901234568 = A | B}} → B
{{#ifexpr: 12345678901234567 = 12345678901234568 | A | B}} → A

生の等号

"Case" 文字列には生の等号を含めることができません。これを回避するには、単一の等号記号 = を含むテンプレート {{=}} を作成するか、または等号記号をHTMLコード &#61; に置き換えます。

例:

{{#switch: 1=2
 | 1=2 = raw
 | 1<nowiki>=</nowiki>2 = nowiki
 | 1{{=}}2 = template
 | default
}}template


{{#switch: 1=2
 | 1&#61;2 = html
 | default
}}html
この関数を実社会で使う易しい例としてNBATemplate:NBA color (訳注:バスケットボールチームの配色用テンプレート) を参照してください。複雑なサンプルは Template:Extension (テンプレート:拡張機能) と w:Template:BOTREQ (訳注:Bot作業依頼のコメント用テンプレート) の2件を参照してください。

#ifeqの置換

拡張深度を減らすには#switchを使用。

例えば:

  • {{#switch:{{{1}}} |condition1=branch1 |condition2=branch2 |condition3=branch3 |branch4}}

は、以下と同等です

  • {{#ifeq:{{{1}}}|condition1 |branch1 |{{#ifeq:{{{1}}}|condition2 |branch2 |{{#ifeq:{{{1}}}|condition3 |branch3 |branch4}}}}}}

i.e. deep nesting, linear:

{{#ifeq:{{{1}}}|condition1
  |<!--then-->branch1
  |<!--else-->{{#ifeq:{{{1}}}|condition2
                |<!--then-->branch2
                |<!--else-->{{#ifeq:{{{1}}}|condition3
                              |<!--then-->branch3
                              |<!--else-->branch4}}}}}}

On the other hand, the switch replacement could be complicated/impractical for IFs nested in both branches (shown with alternatives of indentation, indented on both sides), making full symmetrical tree:

{{#ifeq:{{{1}}}|condition1
 |<!--then-->branch1t{{
  #ifeq:{{{1}}}|condition2
   |<!--then-->branch1t2t{{#ifeq:{{{1}}}|condition4|<!--then-->branch1t2t4t|<!--else-->branch1t2t4e}}
   |<!--else-->branch1t2e{{#ifeq:{{{1}}}|condition5|<!--then-->branch1t2e5t|<!--else-->branch1t2e5e}}
  }}
 |<!--else-->branch1e{{#ifeq:{{{1}}}|condition3
   |<!--then-->branch1e3t{{#ifeq:{{{1}}}|condition6|branch1e3t6t|branch1e3t6e}}
   |<!--else-->branch1e3e{{
    #ifeq:{{{1}}}|condition7
     |branch1e3e7t
     |branch1e3e7t
    }}
  }}
}}

#time

このパーサ関数は日付あるいは時間 (グレゴリア暦) を取って指定の文法どおりにフォーマットします。日・時間のオブジェクトを特定する方法; 既定値は マジックワード {{CURRENTTIMESTAMP}} – つまりページが最近 HTML 形式で表示された日時。

{{#time: format string }}
{{#time: format string | date/time object }}
{{#time: format string | date/time object | language code }}
{{#time: format string | date/time object | language code | local }}

右の図には利用できる書式コードをまとめてあります。もし書式文字列内にこれら以外の文字がふくまれると、未処理で出力します。空白スペースも扱いは同様です (コードの解析に不要なため)。また書式文字列内の文字をエスケープする方法が2つあります。

  1. バックスラッシュに続けて書式指定文字列を記述すると、ひとまとまりのリテラル文字として解釈。
  2. 文字列を二重引用符で囲むと、リテラル文字として扱い引用符を除去。

またさらに、有向グラフxxの場合、ひとまとまりのリテラル文字"x"と解釈します。

{{#time: Y-m-d }}2020-10-29
{{#time: [[Y]] m d }}2020 10 29
{{#time: [[Y (year)]] }}2020 (20UTCamThu, 29 Oct 2020 04:12:23 +0000)
{{#time: [[Y "(year)"]] }}2020 (year)
{{#time: i's" }}12'23"

PHPはdate/time objectを受け取ると、どの書式でも strtotime() 関数で処理します (訳注:英文形式の日付を Unix タイムスタンプに変換)。絶対値 (例:20 December 2000) でも相対値 (例:+20 hours) でも受け取ります。

{{#time: r|now}}Thu, 29 Oct 2020 04:12:24 +0000
{{#time: r|+2 hours}}Thu, 29 Oct 2020 06:12:24 +0000
{{#time: r|now + 2 hours}}Thu, 29 Oct 2020 06:12:24 +0000
{{#time: r|20 December 2000}}Wed, 20 Dec 2000 00:00:00 +0000
{{#time: r|December 20, 2000}}Wed, 20 Dec 2000 00:00:00 +0000
{{#time: r|2000-12-20}}Wed, 20 Dec 2000 00:00:00 +0000
{{#time: r|2000 December 20}}Error: Invalid time.

ISO 639-3 (?) の言語コードにより、文字列を選択した言語で表示します。

{{#time:d F Y|1988-02-28|nl}}28 februari 1988
{{#time:l|now|uk}}четвер
{{#time:d xg Y|20 June 2010|pl}}20 czerwca 2010

The local parameter specifies if the date/time object refers to the local timezone or to UTC.

This is a boolean parameters: its value is determined by casting the value of the argument (see the official PHP documentation for details on how string are cast to boolean values).

Please note that, if the variable $wgLocaltimezone is set to UTC, there is no difference in the output when local is set to true or false.

See the following examples for details:

{{#time: Y F d H:i:s|now|it|0}}2020 ottobre 29 04:12:24
{{#time: Y F d H:i:s|now|it|1}}2020 ottobre 29 04:12:24
{{#time: Y F d H:i:s|+2 hours||0}}2020 10月 29 06:12:24
{{#time: Y F d H:i:s|+2 hours||1}}2020 10月 29 06:12:24
{{#time:c|2019-05-16T17:05:43+02:00|it}}2019-05-16T15:05:43+00:00
{{#time:c|2019-05-16T17:05:43+02:00|it|0}}2019-05-16T15:05:43+00:00
{{#time:c|2019-05-16T17:05:43+02:00|it|true}}2019-05-16T15:05:43+00:00
Unix タイムスタンプを計算する場合は、文字列の先頭に@記号を付けると日付計算に使えます。
{{#time: U | now }}1603944744
{{#time: r | @1603944743 }}Thu, 29 Oct 2020 04:12:23 +0000
警告 警告: もしタイムスタンプの数値の先頭に@を付けないと、ほぼ毎回、エラーか想定外の値を返します。
{{#time: r | 1970-01-01 00:16:39 }}Thu, 01 Jan 1970 00:16:39 +0000
{{#time: U | 1970-01-01 00:16:39 }}999
{{#time: r | @999 }}Thu, 01 Jan 1970 00:16:39 +0000 (正しい)
{{#time: r | 999 }}Error: Invalid time. (年の書式が想定外)
{{#time: r | 1970-01-01 00:16:40 }}Thu, 01 Jan 1970 00:16:40 +0000
{{#time: U | 1970-01-01 00:16:40 }}1000
{{#time: r | @1000 }}Thu, 01 Jan 1970 00:16:40 +0000 (正しい)
{{#time: r | 1000 }}Wed, 29 Oct 1000 00:00:00 +0000 (年を想定、今日の月日を添える)
{{#time: r | 1970-01-01 02:46:39 }}Thu, 01 Jan 1970 02:46:39 +0000
{{#time: U | 1970-01-01 02:46:39 }}9999
{{#time: r | @9999 }}Thu, 01 Jan 1970 02:46:39 +0000 (正しい)
{{#time: r | 9999 }}Fri, 29 Oct 9999 00:00:00 +0000 (年を想定、今日の月日を添える)
{{#time: r | 1970-01-01 02:46:40 }}Thu, 01 Jan 1970 02:46:40 +0000
{{#time: U | 1970-01-01 02:46:40 }}10000
{{#time: r | @10000 }}Thu, 01 Jan 1970 02:46:40 +0000 (正しい)
{{#time: r | 10000 }}Error: Invalid time. (年の書式が想定外)
警告 警告: 許容できる入力値は「1 January 0111 → 31 December 9999」の範囲です。年は100から110までが不定形です。Y (年) とうるう年はその 100-110 と同様に不定形、r (RFC 5322 形式)、D (曜日略号)、l (曜日)、U (Unix日時) を記述すると年を 2000-2010 の範囲として解釈します。
{{#time: d F Y | 29 Feb 0100 }}01 3月 0100
(これはうるう年ではないから出力は正しい)、ただし
{{#time: r | 29 Feb 0100 }}Mon, 01 Mar 0100 00:00:00 +0000 (こちらは間違い。100 を2000と解釈できたのに、うるう年だったため。)
{{#time: d F Y | 15 April 10000 }}Error: Invalid time.
{{#time: r | 10000-4-15 }}Sat, 15 Apr 2000 10:00:00 +0000

先頭に 0 を付けて 4 桁の書式にした場合を除いて、年の値 0-99 は 2000-2069 年および 1970-1999 年と解釈されます:

{{#time: d F Y | 1 Jan 6 }}01 1月 2006
{{#time: d F Y | 1 Jan 06 }}01 1月 2006
{{#time: d F Y | 1 Jan 006 }}01 1月 2006
{{#time: d F Y | 1 Jan 0006 }}01 1月 0006 (4-digit format)
日は年が 100-110 の範囲か、1753以上で与えられ、原因は 111-1752 の範囲では r-出力が「不明」、l-出力が「<>」となってしまうからです。結果として、r-出力はこれらの範囲の年の入力値として許容されません。

完全または部分的な絶対日付を指定できます。この関数は current 値を使用して、指定されていない日付の部分を「補完」します。

{{#time: Y | January 1 }}2020
警告 警告: 補完の関数は不定形です。特定の部分は現在の値で補完され、別の部分はエラーになります。
{{#time: Y m d H:i:s | June }}2020 06 29 00:00:00 この例は日のゼロ時ゼロ分、現在の日、数式に記述した月 (June=6月) と年を表示。
{{#time: Y m d H:i:s | 2003 }}2003 10 29 00:00:00 この例はゼロ時ゼロ分、現在の月日、数式に記述した年を表示。

There's exception case of the filled day:

{{#time: Y m d H:i:s | June 2003 }}2003 06 01 00:00:00 Gives the start of the day and the start of the month.

4桁の数字は常に年として解釈され、時間や分としては解釈されません。[1]

{{#time: Y m d H:i:s | 1959 }}1959 10 29 00:00:00

6桁の数字は時間と解釈、できるかぎり分と秒まで出力しようとしますが、それ以外の場合はエラーになります (たとえば年月日とは解釈しません)。

{{#time: Y m d H:i:s | 195909 }}2020 10 29 19:59:09 記述したコードは年とゼロ補完の月と日を要求したのに、出力は時間として解釈。
{{#time: Y m d H:i:s | 196009 }}Error: Invalid time. 19:60:09 は有効な時刻ではないにもかかわらず、196009 は1960年9月とは解釈されません。

関数は日付計算をこなそうとします。(訳注:Fは「サイトの言語での完全な月名」、dはゼロ補完の日を求め、入力値の不備で出力結果が不定形。)

{{#time: d F Y | January 0 2008 }}31 12月 2007
{{#time: d F | January 32 }}Error: Invalid time.
{{#time: d F | February 29 2008 }}29 2月
{{#time: d F | February 29 2007 }}01 3月
{{#time:Y-F|now -1 months}}2020-9月

#timeに対する書式文字列の文字数上限は半角で6000文字です[2]

タイムゾーンの問題点

この#timeパーサ関数(より具体的にはPHP DateTime )には相対的なタイムゾーンオフセットとして整数以外 は渡せないというバグがあります。EDT (東部夏時間) など時間通りのタイムゾーンを使用する場合、この問題は発生しません。例をあげます。:

  • {{#time:g:i A | -4 hours }} → 12:12 AM

ところがインドは UTC (協定世界時) との時差が +5.5 時間のため、タイムゾーンを適用すると通常なら正しいオフセットの計算に失敗するはずです。実例はこちら:

  • {{#time:g:i A | +5.5 hours }} → 4:12 AM

そこで回避策として、単純に時間を分か秒 (minutes か seconds) に換算して、次の例のように与えます。

  • {{#time:g:i A | +330 minutes }} → 9:42 AM
  • {{#time:g:i A | +19800 seconds }} → 9:42 AM

(関数の開発者 Tim Starling がこれを解決する構文を書いてくれました。)

#timel

この関数は {{#time: ... }} と同一ですが、local パラメーターに true を設定した場合に、常にウィキのローカルの時間を使用する点が異なります (タイムゾーンの設定は $wgLocaltimezone に従う)。

Syntax of the function is:

{{#timel: format string }}
{{#timel: format string | date/time object }}
{{#timel: format string | date/time object | language code }}
Please note that, if the variable $wgLocaltimezone is set to UTC, there is no difference in the output when local is set to true or false
Example of the use of #time and #timel parser functions from a server where the timezone is not UTC

例:

{{#time:c|now|it}}2020-10-29T04:12:24+00:00
{{#time:c|now|it|0}}2020-10-29T04:12:24+00:00
{{#time:c|now|it|1}}2020-10-29T04:12:24+00:00
{{#timel:c|now|it}}2020-10-29T04:12:24+00:00
警告 警告:

Be aware that U for both time and timel will return the same number of seconds since 1970-01-01 00:00:00 UTC on Wikipedias with different timezones than UTC (formerly known as GMT)

U Unix time. Seconds since January 1 1970 00:00:00 GMT.
Z タイムゾーンのオフセット (秒)
{{#time: U}}1603944743
{{#timel: U}}1603944743
{{#time: Z}}0
{{#timel: Z}}0

#titleparts

この関数は、ページのタイトルをスラッシュに基づいてセグメントに分離し、それらのセグメントの一部を出力します。

{{#titleparts: ページ名 | 返すセグメント数 | 最初に返すセグメント }}

If the number of segments to return parameter is not specified, it defaults to "0", which returns all the segments from the first segment to return (included). If the first segment to return parameter is not specified or is "0", it defaults to "1":

{{#titleparts: Talk:Foo/bar/baz/quok }}Talk:Foo/bar/baz/quok
{{#titleparts: Talk:Foo/bar/baz/quok | 1 }}Talk:Foo See also {{ROOTPAGENAME }}.
{{#titleparts: Talk:Foo/bar/baz/quok | 2 }}Talk:Foo/bar
{{#titleparts: Talk:Foo/bar/baz/quok | 2 | 2 }}bar/baz
{{#titleparts: Talk:Foo/bar/baz/quok | | 2 }}bar/baz/quok
{{#titleparts: Talk:Foo/bar/baz/quok | | 5 }}

Negative values are accepted for both values. Negative values for the number of segments to return parameter effectively 'strips' segments from the end of the string. Negative values for the first segment to return translates to "start with this segment counting from the right":

{{#titleparts: Talk:Foo/bar/baz/quok | -1 }}Talk:Foo/bar/baz 文字列の最後から数えてはじめのセグメントを削除します。 {{BASEPAGENAME}} も参照してください。
{{#titleparts: Talk:Foo/bar/baz/quok | -4 }} Strips all 4 segments from the end of the string
{{#titleparts: Talk:Foo/bar/baz/quok | -5 }} Strips 5 segments from the end of the string (more than exist)
{{#titleparts: Talk:Foo/bar/baz/quok | | -1 }} quok Returns last segment. {{SUBPAGENAME}} も参照してください。
{{#titleparts: Talk:Foo/bar/baz/quok | -1 | 2 }} bar/baz Strips one segment from the end of the string, then returns the second segment and beyond
{{#titleparts: Talk:Foo/bar/baz/quok | -1 | -2 }} baz Start copying at the second last element; strip one segment from the end of the string

Before processing, the pagename parameter is HTML-decoded: if it contains some standard HTML character entities, they will be converted to plain characters (internally encoded with UTF-8, i.e. the same encoding as in the MediaWiki source page using this parser function).

For example, any occurrence of &quot;, &#34;, or &#x22; in pagename will be replaced by ".
No other conversion from HTML to plain text is performed, so HTML tags are left intact at this initial step even if they are invalid in page titles.

Some magic keywords or parser functions of MediaWiki (such as {{PAGENAME }} and similar) are known to return strings that are needlessly HTML-encoded, even if their own input parameter was not HTML-encoded:

The titleparts parser function can then be used as a workaround, to convert these returned strings so that they can be processed correctly by some other parser functions also taking a page name in parameter (such as {{PAGESINCAT: }} but which are still not working properly with HTML-encoded input strings.

For example, if the current page is Category:Côte-d'Or, then:

  • {{#ifeq: {{FULLPAGENAME}} | Category:Côte-d'Or | 1 | 0 }}, and {{#ifeq: {{FULLPAGENAME}} | Category:Côte-d&apos;Or | 1 | 0 }} are both returning 1; (the #ifeq parser function does perform the HTML-decoding of its input parameters).
  • {{#switch: {{FULLPAGENAME}} | Category:Côte-d'Or = 1 | #default = 0 }}, and {{#switch: {{FULLPAGENAME}} | Category:Côte-d&apos;Or = 1 | #default = 0 }} are both returning 1; (the #switch parser function does perform the HTML-decoding of its input parameters).
  • {{#ifexist: {{FULLPAGENAME}} | 1 | 0 }}, {{#ifexist: Category:Côte-d'Or | 1 | 0 }}, or even {{#ifexist: Category:Côte-d&apos;Or | 1 | 0 }} will all return 1 if that category page exists (the #ifexist parser function does perform the HTML-decoding of its input parameters);
  • {{PAGESINCAT: Côte-d'Or }} will return a non-zero number, if that category contains pages or subcategories, but:
  • {{PAGESINCAT: {{CURRENTPAGENAME}} }}, may still unconditionally return 0, just like:
  • {{PAGESINCAT: {{PAGENAME|Category:Côte-d'Or}} }}
  • {{PAGESINCAT: {{PAGENAME|Category:Côte-d&apos;Or}} }}

The reason of this unexpected behavior is that, with the current versions of MediaWiki, there are two caveats:

  • {{FULLPAGENAME}}, or even {{FULLPAGENAME|Côte-d'Or}} may return the actually HTML-encoded string Category:Côte-d&apos;Or and not the expected Category:Côte-d'Or, and that:
  • {{PAGESINCAT: Côte-d&apos;Or }} unconditionally returns 0 (the PAGESINCAT magic keyword does not perform any HTML-decoding of its input parameter).

The simple workaround using titleparts (which will continue to work if the two caveats are fixed in a later version of MediaWiki) is:

  • {{PAGESINCAT: {{#titleparts: {{CURRENTPAGENAME}} }} }}
  • {{PAGESINCAT: {{#titleparts: {{PAGENAME|Category:Côte-d'Or}} }} }}
  • {{PAGESINCAT: {{#titleparts: {{PAGENAME|Category:Côte-d&apos;Or}} }} }}, that all return the actual number of pages in the same category.

Then the decoded pagename is canonicalized into a standard page title supported by MediaWiki, as much as possible:

  1. All underscores are automatically replaced with spaces:
    {{#titleparts: Talk:Foo/bah_boo|1|2}}bah boo Not bah_boo, despite the underscore in the original.
  2. The string is split a maximum of 25 times; further slashes are ignored and the 25th element will contain the rest of the string. The string is also limited to 255 characters, as it is treated as a page title:
    {{#titleparts: a/b/c/d/e/f/g/h/i/j/k/l/m/n/o/p/q/r/s/t/u/v/w/x/y/z/aa/bb/cc/dd/ee | 1 | 25 }}y/z/aa/bb/cc/dd/ee
    If for whatever reason you needed to push this function to its limit, although very unlikely, it is possible to bypass the 25 split limit by nesting function calls:
    {{#titleparts: {{#titleparts: a/b/c/d/e/f/g/h/i/j/k/l/m/n/o/p/q/r/s/t/u/v/w/x/y/z/aa/bb/cc/dd/ee| 1 | 25 }} | 1 | 2}}z
  3. Finally the first substring is capitalized according to the capitalization settings of the local wiki (if that substring also starts by a local namespace name, that namespace name is also normalized).
    {{#titleparts: talk:a/b/c }}Talk:A/b/c
警告 警告:

You can use #titleparts as a small "string parser and converter", but consider that it returns the first substring capitalized:

{{#titleparts: one/two/three/four|1|1 }}One
{{#titleparts: one/two/three/four|1|2 }}two

小文字を求めるには lc: 関数を使い出力をコントロールします。

{{lc: {{#titleparts: one/two/three/four|1|1 }} }}one

You can prepend a 'dummy' slash at the beginning of the string to get the correct first substring capitalization (uppercase or lowercase). Use 2 instead of 1 for first segment to return:

{{#titleparts: /one/two/three/four|1|2 }}one
{{#titleparts: /One/two/three/four|1|2 }}One
警告 警告:

Certain characters that are illegal in a page title will cause #titleparts to not parse the string:

{{#titleparts: {one/two} | 1 | 1 }}{one/two}. 以下の値にはなりません: {one
{{#titleparts: [[page]]/123 | 1 | 2 }}page/123. Does not work because brackets are illegal in page titles and this parser function does not process links embedded in its input pagename parameter, even when they use the MediaWiki syntax, or any other HTML or MediaWiki tags.
{{#titleparts: red/#00FF00/blue | 1 | 3 }} → "". Does not work because "#" is also illegal in page titles.
警告 警告:

If any part of the title is just "." or "..", #titleparts will not parse the string:

{{#titleparts: one/./three | 1 | 1 }}one/./three. The whole string is returned. It does not produce the expected: one
警告 警告: This function does not degrade gracefully if the input exceeds 255 bytes in UTF-8. If the input string is 256 bytes or more, the whole string is returned.

StringFunctions

All of these functions (len, pos, rpos, sub, replace, explode) are integrated from the StringFunctions extension, but are only available if an administrator sets $wgPFEnableStringFunctions = true; in LocalSettings.php.

All of these functions operate in O(n) time complexity, making them safe against DoS attacks.

  1. Some parameters of these functions are limited through global settings to prevent abuse.
See section Limits hereafter.
  1. For functions that are case sensitive, you may use the magic word {{lc:string}} as a workaround in some cases.
  1. To determine whether a MediaWiki server enables these functions, check the list of supported Extended parser functions in Special:Version.
  1. String length is limited by $wgPFStringLengthLimit variable, default to 1000.

#len

The #len parser function was merged from the StringFunctions extension as of version 1.2.0.

The #len function returns the length of the given string. 構文は以下の通りです:

{{#len:string}}

The return value is always a number of characters in the source string (after expansions of template invocations, but before conversion to HTML). If no string is specified, the return value is zero.

  • This function is safe with UTF-8 multibyte characters.
例:
    • {{#len:Žmržlina}}8
  • Leading and trailing spaces or newlines are not counted, but intermediate spaces and newlines are taken into account.
例:
    • {{#len:Icecream }}8
    • {{#len: a   b }}5 - 3 spaces between 2 characters
  • Characters given by reference are not converted, but counted according to their source form.
    • {{#len:&nbsp;}}6 - named characters references
    • {{#len:&#32;}}5 - numeric characters references, not ignored despite it designates a space here.
  • Tags such as <nowiki> and other tag extensions will always have a length of zero, since their content is hidden from the parser.
例:
    • {{#len:<nowiki>This is a </nowiki>test}}4

#pos

The #pos parser function was merged from the StringFunctions extension as of version 1.2.0.

The #pos function returns the position of a given search term within the string. 構文は以下の通りです:

{{#pos:string|search term|offset}}

The offset parameter, if specified, tells a starting position where this function should begin searching.

If the search term is found, the return value is a zero-based integer of the first position within the string.

If the search term is not found, the function returns an empty string.

  • This function is case sensitive.
  • This function is safe with UTF-8 multibyte characters.
例: {{#pos:Žmržlina|žlina}} は 3 を返します。
  • As with #len, <nowiki> and other tag extensions are treated as having a length of 1 for the purposes of character position.
例: {{#pos:<nowiki>This is a </nowiki>test|test}} は 1 を返します。

#rpos

The #rpos parser function was merged from the StringFunctions extension as of version 1.2.0.

The #rpos function returns the last position of a given search term within the string. 構文は以下の通りです:

 {{#rpos:string|search term}}

If the search term is found, the return value is a zero-based integer of its last position within the string.

If the search term is not found, the function returns -1.

When using this to search for the last delimiter, add +1 to the result to retrieve position after the last delimiter. This also works when the delimiter is not found, because "-1 + 1" is zero, which is the beginning of the given value.
  • This function is case sensitive.
  • This function is safe with UTF-8 multibyte characters.
例: {{#rpos:Žmržlina|lina}} は 4 を返します。
  • As with #len, <nowiki> and other tag extensions are treated as having a length of 1 for the purposes of character position.
例: {{#rpos:<nowiki>This is a </nowiki>test|test}} は 1 を返します。

#sub

The #sub parser function was merged from the StringFunctions extension as of version 1.2.0.

The #sub function returns a substring from the given string. 構文は以下の通りです:

{{#sub:string|start|length}}

The start parameter, if positive (or zero), specifies a zero-based index of the first character to be returned.

例: {{#sub:Icecream|3}}cream を返します。

{{#sub:Icecream|0|3}}Ice を返します。

If the start parameter is negative, it specifies how many characters from the end should be returned.

例: {{#sub:Icecream|-3}}eam を返します。

The length parameter, if present and positive, specifies the maximum length of the returned string.

例: {{#sub:Icecream|3|3}}cre を返します。

If the length parameter is negative, it specifies how many characters will be omitted from the end of the string.

例: {{#sub:Icecream|3|-3}}cr を返します。

If the start parameter is negative, it specifies how many characters from the end should be returned. The length parameter, if present and positive, specifies the maximum length of the returned string from the starting point.

例: {{#sub:Icecream|-3|2}}ea を返します。

  • If the length parameter is zero, it is not used for truncation at all.
    • Example: {{#sub:Icecream|3|0}}cream を返します。 {{#sub:Icecream|0|3}}Ice を返します。
  • If start denotes a position beyond the truncation from the end by negative length parameter, an empty string will be returned.
    • Example: {{#sub:Icecream|3|-6}} は空の文字列を返します。
  • This function is safe with UTF-8 multibyte characters.
Example: {{#sub:Žmržlina|3}}žlina を返します。
  • As with #len, <nowiki> and other tag extensions are treated as having a length of 1 for the purposes of character position.
Example: {{#sub:<nowiki>This is a </nowiki>test|1}}test を返します。

#replace

The #replace parser function was merged from the StringFunctions extension as of version 1.2.0.

The #replace function returns the given string with all occurrences of a search term replaced with a replacement term.

{{#replace:string|search term|replacement term}}

If the search term is unspecified or empty, a single space will be searched for.

If the replacement term is unspecified or empty, all occurrences of the search term will be removed from the string.

  • This function is case-sensitive.
  • Even if the replacement term is a space, an empty string is used.
This is a side-effect of the MediaWiki parser.

To use a space as the replacement term, put it in nowiki tags.

    • Example: {{#replace:My_little_home_page|_|<nowiki> </nowiki>}}My little home page を返します。
    • If this doesn't work, try {{#replace:My_little_home_page|_|<nowiki/> <nowiki/>}} with two self-closing tags.
    • Note that this is the only acceptable use of nowiki in the replacement term, as otherwise nowiki could be used to bypass $wgStringFunctionsLimitReplace, injecting an arbitrarily large number of characters into the output.
For this reason, all occurrences of <nowiki> or any other tag extension within the replacement term are replaced with spaces.
  • This function is safe with UTF-8 multibyte characters.
Example: {{#replace:Žmržlina|ž|z}}Žmrzlina を返します。
  • If multiple items in a single text string need to be replaced, one could also consider Extension:ReplaceSet .
It adds a parser function for a sequence of replacements.
Case-insensitive replace

Currently the syntax doesn't provide a switch to toggle case-sensitivity setting. But you may make use of magic words of formatting as a workaround. (e.g. {{lc:your_string_here}}) For example, if you want to remove the word "Category:" from the string regardless of its case, you may type:

{{#replace:{{lc:{{{1}}}}}|category:|}}

But the disadvantage is that the output will become all lower-case. If you want to keep the casing after replacement, you have to use multiple nesting levels (i.e. multiple replace calls) to achieve the same thing.

#explode

The #explode parser function was merged from the StringFunctions extension as of version 1.2.0.

The #explode function splits the given string into pieces and then returns one of the pieces. The syntax is:

{{#explode:string|delimiter|position|limit}}

The delimiter parameter specifies a string to be used to divide the string into pieces. This delimiter string is then not part of any piece, and when two delimiter strings are next to each other, they create an empty piece between them. If this parameter is not specified, a single space is used. The limit parameter is available in ParserFunctions only, not the standalone StringFunctions version, and allows you to limit the number of parts returned, with all remaining text included in the final part.

The position parameter specifies which piece is to be returned. Pieces are counted from 0. If this parameter is not specified, the first piece is used (piece with number 0). When a negative value is used as position, the pieces are counted from the end. In this case, piece number -1 means the last piece. Examples:

  • {{#explode:And if you tolerate this| |2}} returns you
  • {{#explode:String/Functions/Code|/|-1}} returns Code
  • {{#explode:Split%By%Percentage%Signs|%|2}} returns Percentage
  • {{#explode:And if you tolerate this| |2|3}} returns you tolerate this

The return value is the position-th piece. If there are fewer pieces than the position specifies, an empty string is returned.

  • This function is case sensitive.
  • The maximum allowed length of the delimiter is limited through $wgStringFunctionsLimitSearch global setting.
  • This function is safe with UTF-8 multibyte characters. Example: {{#explode:Žmržlina|ž|1}} returns lina.

#urldecode

#urldecode converts the escape characters from an 'URL encoded' string string back to readable text. The syntax is:

{{#urldecode:value}}

Notes:

  • This function works by directly exposing PHP's urldecode() function.
  • A character-code-reference can be found at www.w3schools.com.
  • The opposite, urlencode, has been integrated into MediaWiki as of version 1.18; for examples, see Help:Magic Words .
  • urldecode was merged from Stringfunctions in 2010, by commit 1b75afd18d3695bdb6ffbfccd0e4aec064785363

Limits

This module defines three global settings:

These are used to limit some parameters of some functions to ensure the functions operate in O(n) time complexity, and are therefore safe against DoS attacks.

$wgStringFunctionsLimitSearch

This setting is used by #pos, #rpos, #replace, and #explode. All these functions search for a substring in a larger string while they operate, which can run in O(n*m) and therefore make the software more vulnerable to DoS attacks. By setting this value to a specific small number, the time complexity is decreased to O(n).

This setting limits the maximum allowed length of the string being searched for.

The default value is 30 multibyte characters.

$wgStringFunctionsLimitReplace

This setting is used by #replace. This function replaces all occurrences of one string for another, which can be used to quickly generate very large amounts of data, and therefore makes the software more vulnerable to DoS attacks. This setting limits the maximum allowed length of the replacing string.

The default value is 30 multibyte characters.

全般的な情報

subst展開

Parser functions can be substituted by prefixing the hash character with subst::

{{subst:#ifexist: Help:Extension:ParserFunctions/ja | [[Help:Extension:ParserFunctions/ja]] | Help:Extension:ParserFunctions/ja }}the code [[Help:Extension:ParserFunctions/ja]] will be inserted in the wikitext since the page Help:Extension:ParserFunctions/ja exists.
警告 警告:

The results of substituted parser functions are undefined if the expressions contain unsubstituted volatile code such as variables or other parser functions. For consistent results, all the volatile code in the expression to be evaluated must be substituted. See Help:Substitution.

Substitution does not work within <ref></ref> , you can use {{subst:#tag:ref|}} for this purpose.

リダイレクト

Especially {{#time:…|now-…}} could be handy in redirects to pages including dates, but this does not work.

表内でのパイプ記号のエスケープ

Parser functions will mangle wikitable syntax and pipe characters (|), treating all the raw pipe characters as parameter dividers. To avoid this, most wikis used a template Template:! with its contents only a raw pipe character (|), since MW 1.24 a {{!}} magic word replaced this kludge. This 'hides' the pipe from the MediaWiki parser, ensuring that it is not considered until after all the templates and variables on a page have been expanded. It will then be interpreted as a table row or column separator. Alternatively, raw HTML table syntax can be used, although this is less intuitive and more error-prone.

パイプ記号は、プレーンな (解釈されない) 文字としてエスケープすることもできます。これには HTML エンティティ &#124; を使用します。

説明 入力内容 結果
パイプ記号を表の行/列区切りとしてエスケープ
{{!}}
|
パイプ記号をプレーンな文字としてエスケープ
&#124;
|

空白類の除去

空白 (改行、タブ、空白アキ) はパーサ関数の全パラメータの開始から終了まで除去します。これを回避するには、引用符で囲んでから文字列を比較します。

{{#ifeq: foo           |           foo | equal | not equal }}equal
{{#ifeq: "foo          " | "          foo" | equal | not equal }}not equal

then 部分および else 部分での空白の除去を回避する方法は m:Template:Ifを参照してください。空白の代わりに <nowiki > </nowiki> を使用することもできます。

foo{{#if:|| bar }}foofoobarfoo
foo{{#if:||<nowiki /> bar <nowiki />}}foofoo bar foo

ただし連続する複数の空白文字はパーサにより1文字に圧縮されるため、この方法により処理できるのは1文字の空白文字に限定されます。

<span style="white-space: pre;">foo{{#if:||<nowiki></nowiki>      bar      <nowiki></nowiki>}}foo</span>
foo bar foo

このサンプルでは white-space: pre 書式を採用してブラウザ上で非表示でも、空白スペースが保持されるように強制します。ソフトウェアにより、ブラウザに渡す前に空白文字が除去されるため発生します。

この挙動を回避するには、ソフトウェアによって置換されないように空白スペースを&#32; (breakable space) もしくは&nbsp; (non-breakable space) に置換します。

<span style="white-space: pre;">foo{{#if:||&#32;&#32;&#32;bar&#32;&#32;&#32;}}foo</span>foo bar foo
foo{{#if:||&nbsp;&nbsp;&nbsp;bar&nbsp;&nbsp;&nbsp;}}foofoo   bar   foo

関連項目

脚注

  1. 2011年のr86805以前とは扱いが変わりました。
  2. phabricator.wikimedia.orgのExtParserFunctions.php を参照してください。