MediaWiki\Hook\ParserFetchTemplateDataHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. More...

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onParserFetchTemplateData (array $titles, array &$tplData)
	This hook allows Parsoid to fetch additional serialization information about a Template, including the type of its arguments, whether they should be serialized as inline or block style wikitext, etc.

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "ParserFetchTemplateData" to register handlers implementing this interface.

Stability: unstable

Definition at line 13 of file ParserFetchTemplateDataHook.php.

Member Function Documentation

onParserFetchTemplateData()

MediaWiki\Hook\ParserFetchTemplateDataHook::onParserFetchTemplateData	(	array	$titles,
		array &	$tplData )

This hook allows Parsoid to fetch additional serialization information about a Template, including the type of its arguments, whether they should be serialized as inline or block style wikitext, etc.

See [[Extension:TemplateData]] for more information.

Parameters

string[]	$titles	An array of template names
	array<string,object>	&$tplData The hook will create an associative array, mapping each given template name to an object representing the TemplateData for that template, or special objects if the title doesn't exist, is missing TemplateData, or has malformed TemplateData.

Returns

bool Typically returns true, to allow all registered hooks a chance to fill in template data.

Stability: unstable

temporary hook; will be cleaned up before it is made stable

Since

1.39

Implemented in MediaWiki\HookContainer\HookRunner.

---

The documentation for this interface was generated from the following file:

• includes/parser/Hook/ParserFetchTemplateDataHook.php