Manual:Hooks/ParserLimitReportFormat

From MediaWiki.org
Jump to navigation Jump to search
ParserLimitReportFormat
Available from version 1.22.0
Removed in version 1.28.0
Called for each row in the parser limit report that needs formatting.
Define function:
public static function onParserLimitReportFormat( $key, &$value, &$report, $isHTML, $localize ) { ... }
Attach hook:

In extension.json:

{
	"Hooks": {
		"ParserLimitReportFormat": "MyExtensionHooks::onParserLimitReportFormat"
	}
}

For MediaWiki ≤1.25:

$wgHooks['ParserLimitReportFormat'][] = 'MyExtensionHooks::onParserLimitReportFormat';
Called from:File(s): parser/Parser.php
Function(s): makeLimitReport

For more information about attaching hooks, see Manual:Hooks.
For examples of extensions using this hook, see Category:ParserLimitReportFormat extensions.

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.

Details[edit]

  • $key: Key for the limit report item (string)
  • &$value: Value of the limit report item
  • &$report: String onto which to append the data
  • $isHTML: If true, $report is an HTML table with two columns; if false, it's text intended for display in a monospaced font.
  • $localize: If false, $report should be output in English.