Manual:Hooks/BaseTemplateAfterPortlet

From MediaWiki.org
Jump to navigation Jump to search
BaseTemplateAfterPortlet
Available from version 1.23.0
Occurs whenever a page is rendered and allows to add HTML after portlets have been put out.
Define function:
public static function onBaseTemplateAfterPortlet( $template, $portlet, &$html ) { ... }
Attach hook:

In extension.json:

{
	"Hooks": {
		"BaseTemplateAfterPortlet": "MyExtensionHooks::onBaseTemplateAfterPortlet"
	}
}

For MediaWiki ≤1.25:

$wgHooks['BaseTemplateAfterPortlet'][] = 'MyExtensionHooks::onBaseTemplateAfterPortlet';
Called from:File(s): SkinTemplate.php

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

After output of portlets, allow injecting custom HTML after the section. Any uses of the hook need to handle escaping.

Details[edit]

  • $template BaseTemplate
  • $portlet: string portlet name
  • &$html: string The HTML code to display. Will be wrapped into a div tag, but apart from that will be output into the page directly. Escape dangerous signs!