Jump to content

Manual:Hooks/OutputPageParserOutput

From mediawiki.org
OutputPageParserOutput
Available from version 1.6.0
Called after parse, before the HTML is added to the output
Define function:
public static function onOutputPageParserOutput( OutputPage $out, ParserOutput $parserOutput ) { ... }
Attach hook: In extension.json:
{
	"Hooks": {
		"OutputPageParserOutput": "MediaWiki\\Extension\\MyExtension\\Hooks::onOutputPageParserOutput"
	}
}
Called from: File(s): Output/OutputPage.php
Function(s): addParserOutputMetadata
Interface: OutputPageParserOutputHook.php

For more information about attaching hooks, see Manual:Hooks .
For examples of extensions using this hook, see Category:OutputPageParserOutput extensions.

Called directly after the LanguageLinks hook is provided.

Arguments

[edit]

Setting Parser properties for use by this hook

[edit]

Are you contributing to an extension and want to set a parser property that can later be used by the OutputPageParserOutput hook? The ParserOutput::setExtensionData() and ::appendExtensionData() methods and are available for your purpose.

For instance, if somewhere in your code, you define a property like:

$parser->getOutput()->setExtensionData( 'my_ext_foo', '...' );

In your method for this hook, you can fetch the value from the ParserOutput like this:

$parserOutput->getExtensionData( 'my_ext_foo' );