MediaWiki  master
MediaWiki\Hook\ParserLimitReportFormatHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\ParserLimitReportFormatHook:

Public Member Functions

 onParserLimitReportFormat ( $key, &$value, &$report, $isHTML, $localize)
 This hook is called for each row in the parser limit report that needs formatting. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 12 of file ParserLimitReportFormatHook.php.

Member Function Documentation

◆ onParserLimitReportFormat()

MediaWiki\Hook\ParserLimitReportFormatHook::onParserLimitReportFormat (   $key,
$value,
$report,
  $isHTML,
  $localize 
)

This hook is called for each row in the parser limit report that needs formatting.

If nothing handles this hook, the default is to use "$key" to get the label, and "$key-value" or "$key-value-text"/"$key-value-html" to format the value.

Since
1.35
Parameters
string$keyKey for the limit report item
string&$valueValue of the limit report item
string&$reportString onto which to append the data
string$isHTMLIf true, $report is an HTML table with two columns; if false, it's text intended for display in a monospaced font
bool$localizeIf false, $report should be output in English
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: