MediaWiki\Hook\SidebarBeforeOutputHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\SidebarBeforeOutputHook:

Public Member Functions
	onSidebarBeforeOutput ( $skin, &$sidebar)
	Use this hook to edit the sidebar just before it is output by skins.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 of file SidebarBeforeOutputHook.php.

Member Function Documentation

onSidebarBeforeOutput()

MediaWiki\Hook\SidebarBeforeOutputHook::onSidebarBeforeOutput	(		$skin,
		&	$sidebar
	)

Use this hook to edit the sidebar just before it is output by skins.

Warning: This hook is run on each display. You should consider using 'SkinBuildSidebar', which is aggressively cached.

Since

1.35

Parameters

Skin	$skin
array	&$sidebar	Sidebar content. Modify $sidebar to add or modify sidebar portlets.

Returns

void This hook must not abort; it must not return value.

Implemented in MediaWiki\HookContainer\HookRunner.

---

The documentation for this interface was generated from the following file:

• includes/skins/Hook/SidebarBeforeOutputHook.php