Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
Total | n/a |
0 / 0 |
n/a |
0 / 0 |
CRAP | n/a |
0 / 0 |
1 | <?php |
2 | |
3 | namespace MediaWiki\Page\Hook; |
4 | |
5 | use Article; |
6 | use MediaWiki\Parser\ParserOutput; |
7 | |
8 | /** |
9 | * This is a hook handler interface, see docs/Hooks.md. |
10 | * Use the hook name "ArticleViewHeader" to register handlers implementing this interface. |
11 | * |
12 | * @stable to implement |
13 | * @ingroup Hooks |
14 | */ |
15 | interface ArticleViewHeaderHook { |
16 | /** |
17 | * Use this hook to control article output. This hook is called before the parser |
18 | * cache is about to be tried for article viewing. |
19 | * |
20 | * @since 1.35 |
21 | * |
22 | * @param Article $article |
23 | * @param bool|ParserOutput|null &$outputDone Whether the output for this page finished or not. Set to |
24 | * a ParserOutput object to both indicate that the output is done and what |
25 | * parser output was used. |
26 | * @param bool &$pcache Whether to try the parser cache or not |
27 | * @return bool|void True or no return value to continue or false to abort |
28 | */ |
29 | public function onArticleViewHeader( $article, &$outputDone, &$pcache ); |
30 | } |