Manual:Parser functions/ja

Parser functions, added in MediaWiki 1.7, are a type of extension that integrate closely with the parser. The phrase "parser function" should not be confused with, which is a collection of simple parser functions. (See for those.)

説明
Whereas a Tag extension is expected to take unprocessed text and return HTML to the browser, a parser function can 'interact' with other wiki elements in the page. For example, the output of a parser function could be used as a template parameter or in the construction of a link.

パーサー関数の典型的な構文は以下の通りです:

For more information, see for. This documentation states:
 * The callback function should have the form:
 * Or with :
 * Or with :

パーサー関数の作成は、タグフックを作成する場合よりも多少込み入っています. これは、関数名がマジックワードでなければならないためです; マジックワードは、別名および多言語対応をサポートする一種のキーワードです.

単純な例
パーサー関数を生成する拡張機能の例を以下に示します.

The registration goes into extension.json and the code into src/ExampleExtension.php respectively:

Another file, ExampleExtension.i18n.php, should contain:

With this extension enabled,



以下の出力を生成します:


 * param1 is hello and param2 is hi and param3 is hey

より長い関数
より複雑な関数を記述する場合には、フック関数を _body.php または .hooks.php ファイルに分離し、これらを適当なクラスの静的関数としてもよいでしょう. この場合、クラスは でロードして、フックから静的関数を呼び出せます. 例えば:

以下のコードを  ファイルに追加します: 次に、以下のコードを  ファイルに追加します:
 * See: writing an event handler for other styles.

キャッシュ
タグ機能拡張の場合と同様に、動的機能拡張としたい場合は、$parser->disableCache を使用してキャッシュを無効にできます.

出力の構文解析の制御
作成したパーサー関数が返すウィキテキストが完全に構文解析されるようにする (テンプレートの展開を含む) には、戻り値の  オプションに false を設定します:

の既定値は、ある時点、バージョン 1.12 付近のどこかで、false から true に変更されたようです.

逆に、作成したパーサー関数が、ウィキテキストを返すのではなく、構文解析されないままの HTML を返すようにするには、以下のように指定します:

しかし、 This is a test. の記述は、以下のような出力を生成します:

This is

param1 is hello and param2 is hi and param3 is hey a test.

これは、パーサー関数の HTML 出力に、ハードコードされた "\n\n" 文字列が前置されることが原因です. この現象を回避するには、HTML コードが周りのテキストに対してインラインでレンダリングされるようにするため、以下のように記述します:

命名
By default, MW adds a hash character (number sign, "#") to the name of each parser function. To suppress that addition (and obtain a parser function with no "#" prefix), include the SFH_NO_HASH constant in the optional flags argument to setFunctionHook, as described below.

When choosing a name without a hash prefix, note that transclusion of a page with a name starting with that function name followed by a colon is no longer possible. In particular, avoid function names equal to a namespace name. In the case that interwiki transclusion is enabled, also avoid function names equal to an interwiki prefix.

setFunctionHook フック
For more details of the interface into the parser, see the documentation for setFunctionHook in includes/Parser.php. Here's a (possibly dated) copy of those comments:

function setFunctionHook( $id, $callback, $flags = 0 ) パラメーター:


 * string $id - マジックワード ID
 * mixed $callback - 使用するコールバック関数 (とオブジェクト)
 * integer $flags - (省略可能) 関数を「#」なしで呼び出すようにするには、SFH_NO_HASH 定数を設定します.

戻り値: この名前の元のコールバック関数 (ある場合)

Create a function, e.g.,. The callback function should have the form:

The callback may either return the text result of the function, or an array with the text in element 0, and a number of flags in the other elements. The names of the flags are specified in the keys. Valid flags are:


 * found : The text returned is valid, stop processing the template. This is on by default.
 * nowiki : Wiki markup in the return value should be escaped
 * noparse : Unsafe HTML tags should not be stripped, etc.
 * noargs : Don't replace triple-brace arguments in the return value
 * isHTML : The returned text is HTML, armour it against wikitext transformation

名前付きパラメーター
Parser functions do not support named parameters the way templates and tag extensions do, but it is occasionally useful to fake it. Users are often accustomed to using vertical bars ( | ) to separate arguments, so it's nice to be able to do that in the parser function context, too. Here's a simple example of how to accomplish this:

関連項目

 * ParserFunctions 拡張機能は、よく知られたパーサー関数のコレクションです.
 * The Parser Hooks PHP library, which provides an object orientated interface for declarative parser hooks
 * ParserFunctions 拡張機能は、よく知られたパーサー関数のコレクションです.
 * The Parser Hooks PHP library, which provides an object orientated interface for declarative parser hooks
 * ParserFunctions 拡張機能は、よく知られたパーサー関数のコレクションです.
 * The Parser Hooks PHP library, which provides an object orientated interface for declarative parser hooks
 * ParserFunctions 拡張機能は、よく知られたパーサー関数のコレクションです.
 * The Parser Hooks PHP library, which provides an object orientated interface for declarative parser hooks
 * The Parser Hooks PHP library, which provides an object orientated interface for declarative parser hooks