MediaWiki master
MediaWiki\OutputTransform\Hook\OutputTransformFirstStageHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions

 onOutputTransformFirstStage (ParserOutput &$parserOutput, ParserOptions $parserOptions)
 This hook is called from the post-processing output transform pipeline at the very start of processing to do post-cache transformations.
 

Detailed Description

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

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

Stability: stable
to implement

Definition at line 18 of file OutputTransformFirstStageHook.php.

Member Function Documentation

◆ onOutputTransformFirstStage()

MediaWiki\OutputTransform\Hook\OutputTransformFirstStageHook::onOutputTransformFirstStage ( ParserOutput & $parserOutput,
ParserOptions $parserOptions )

This hook is called from the post-processing output transform pipeline at the very start of processing to do post-cache transformations.

You can implement this hook directly for simple transforms.

However, if you would like to use the machinery of OutputTransformStage (for example, ContentHolderTransformStage for transforms that can operate on either HTML or DOM), you can use the OutputTransformStageHookTrait to implement this hook from any class that extends OutputTransformStage.

Since
1.47
Parameters
ParserOutput&$parserOutputThe ParserOutput to modify
ParserOptions$parserOptionsOptions controlling this transformation

Implemented in MediaWiki\HookContainer\HookRunner.


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