ArticleViewHeaderHook.php
No OneTemporary
Actions

Size

962 B

Referenced Files

None

Subscribers

None

ArticleViewHeaderHook.php
View Options

	<?php

	namespace MediaWiki\Page\Hook;

	use MediaWiki\Page\Article;
	use MediaWiki\Parser\ParserOutput;

	/**
	* This is a hook handler interface, see docs/Hooks.md.
	* Use the hook name "ArticleViewHeader" to register handlers implementing this interface.
	*
	* @stable to implement
	* @ingroup Hooks
	*/
	interface ArticleViewHeaderHook {
	/**
	* 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
	*
	* @param Article $article
	* @param bool\|ParserOutput\|null &$outputDone Whether 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.
	* @param bool &$pcache Whether to try the parser cache or not
	* @return bool\|void True or no return value to continue or false to abort
	*/
	public function onArticleViewHeader( $article, &$outputDone, &$pcache );
	}