Manual:Parser functions/zh

在MediaWiki 1.7中添加的解析器函數是一種與解析器緊密集成的擴展. 短語“解析器函數”不應與Extension:ParserFunctions混淆，後者是簡單解析器函數的集合. （請參閱Help:Extension:ParserFunctions. ）

描述
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.

解析器函數的典型語法是：

有關更多信息，請參閱的. 本文檔說明：
 * 回調函數應具有以下形式：
 * 或者和或者 :
 * 或者和或者 :

創建解析器函數比創建新標記稍微複雜一些，因為函數名稱必須是魔術字，這是一個支持別名和本地化的關鍵字.

简单例子
下面是一個創建解析器函數的擴展示例.

註冊進入extension.json，代碼進入ExampleExtension.class.php：

另一個文件ExampleExtension.i18n.php應該包含：

啟用此擴展程序後，



生产：


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

较长的函数
For longer functions, you may want to split the hook functions out to a _body.php or .hooks.php file and make them static functions of a class. Then you can load the class with and call the static functions in the hooks; e.g.:

Put this in your  file: Then put this is in your  file:
 * See: writing an event handler for other styles.

缓存
As with tag extensions, $parser->disableCache may be used to disable the cache for dynamic extensions.

Controlling the parsing of output
To have the wikitext returned by your parser function be fully parsed (including expansion of templates), set the  option to false when returning:

It seems the default value for  changed from false to true, at least in some situations, sometime around version 1.12.

Conversely, to have your parser function return HTML that remains unparsed, rather than returning wikitext, use this:

However, This is a test. will produce something like this:

This is

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

This happens due to a hardcoded "\n\n" that is prepended to the HTML output of parser functions. To avoid that and make sure the HTML code is rendered inline to the surrounding text, you can use this:

命名
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.

The setFunctionHook hook
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 - The magic word ID
 * mixed $callback - The callback function (and object) to use
 * integer $flags - Optional, set it to the SFH_NO_HASH constant to call the function without "#".

Return value: The old callback function for this name, if any

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

Named parameters
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:

参见

 * The ParserFunctions extension is a well-known collection of parser functions.
 * The Parser Hooks PHP library, which provides an object orientated interface for declarative parser hooks
 * The ParserFunctions extension is a well-known collection of parser functions.
 * The Parser Hooks PHP library, which provides an object orientated interface for declarative parser hooks
 * The ParserFunctions extension is a well-known collection of parser functions.
 * The Parser Hooks PHP library, which provides an object orientated interface for declarative parser hooks
 * The ParserFunctions extension is a well-known collection of parser functions.
 * 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