MediaWiki\Parser\Hook\ParserOutputPostCacheTransformHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onParserOutputPostCacheTransform ( $parserOutput, &$text, &$options)
	This hook is called from during the post-processing output transform pipeline to do post-cache transforms.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 of file ParserOutputPostCacheTransformHook.php.

Member Function Documentation

onParserOutputPostCacheTransform()

MediaWiki\Parser\Hook\ParserOutputPostCacheTransformHook::onParserOutputPostCacheTransform	(		$parserOutput,
		&	$text,
		&	$options )

This hook is called from during the post-processing output transform pipeline to do post-cache transforms.

Since

1.35

Parameters

ParserOutput	$parserOutput
string	&$text	Text being transformed, before core transformations are done
array	&$options	Options array being used for the transformation. It can contain values documented for the $options array in \MediaWiki\Parser\ParserOutput::runOutputPipeline. Additionally, it temporarily contains the ParserOptions used to parse the ParserOutput, associated to the 'parserOptions' key. This is considered an internal behaviour and should not be relied on. A future hook will replace this one to be able to pass the desired set of parameters, including ParserOptions.

Stability: unstable

since 1.46 for the 'parserOptions' key of $options

Returns

void This hook must not abort, it must return no value

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/Parser/Hook/ParserOutputPostCacheTransformHook.php