MediaWiki  master
Page\Hook\ArticleViewHeaderHook Interface Reference

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

Inheritance diagram for Page\Hook\ArticleViewHeaderHook:

Public Member Functions

 onArticleViewHeader ( $article, &$outputDone, &$pcache)
 Use this hook to control article output. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 15 of file ArticleViewHeaderHook.php.

Member Function Documentation

◆ onArticleViewHeader()

Page\Hook\ArticleViewHeaderHook::onArticleViewHeader (   $article,
$outputDone,
$pcache 
)

Use this hook to control article output.

This hook is called before the parser cache is about to be tried for article viewing.

Since
1.35
Parameters
Article$article
bool | ParserOutput&$outputDoneWhether the output for this page finished or not. Set to a ParserOutput object to both indicate that the output is done and what parser output was used.
bool&$pcacheWhether to try the parser cache or not
Returns
bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.


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