wiki.techinc.nl/includes/parser/Hook/ParserLimitReportPrepareHook.php
apaskulin c44488f725 docs: Hook interface doc comment review
Edited doc comments for hook interfaces to improve
consistency and add type hints.

Bug: T246855
Change-Id: I38fa802463cd6f39bf5946dbbeb1b3ebaea604b2
2020-04-21 09:10:08 +10:00

26 lines
688 B
PHP

<?php
namespace MediaWiki\Hook;
use Parser;
use ParserOutput;
/**
* @stable for implementation
* @ingroup Hooks
*/
interface ParserLimitReportPrepareHook {
/**
* This hook is called at the end of Parser:parse() when the parser
* will include comments about size of the text parsed. Hooks should use
* $output->setLimitReportData() to populate data. Functions for this hook should
* not use $wgLang; do that in ParserLimitReportFormat instead.
*
* @since 1.35
*
* @param Parser $parser
* @param ParserOutput $output
* @return bool|void True or no return value to continue or false to abort
*/
public function onParserLimitReportPrepare( $parser, $output );
}