blob: 025ce2c9622c40c6893599d000afe5569849ae18 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
|
<?php
namespace MediaWiki\Hook;
use MediaWiki\Skin\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;
}
|
