SidebarBeforeOutputHook.php
No OneTemporary
Actions

Size

841 B

Referenced Files

None

Subscribers

None

SidebarBeforeOutputHook.php
View Options

	<?php

	namespace MediaWiki\Hook;

	use Skin;

	/**
	* This is a hook handler interface, see docs/Hooks.md.
	* Use the hook name "SidebarBeforeOutput" to register handlers implementing this interface.
	*
	* @stable to implement
	* @ingroup Hooks
	*/
	interface SidebarBeforeOutputHook {
	/**
	* 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
	*
	* @param Skin $skin
	* @param array &$sidebar Sidebar content. Modify $sidebar to add or modify sidebar portlets.
	* See {@link Skin::buildSidebar()} for the structure of $sidebar.
	* @return void This hook must not abort; it must not return value.
	*/
	public function onSidebarBeforeOutput( $skin, &$sidebar ): void;
	}