MediaWiki\Hook\SkinSubPageSubtitleHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onSkinSubPageSubtitle (&$subpages, $skin, $out)
	This hook is called at the beginning of Skin::subPageSubtitle().

Detailed Description

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

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

Stability: stable

to implement

Definition at line 15 of file SkinSubPageSubtitleHook.php.

Member Function Documentation

onSkinSubPageSubtitle()

MediaWiki\Hook\SkinSubPageSubtitleHook::onSkinSubPageSubtitle	(	&	$subpages,
			$skin,
			$out )

This hook is called at the beginning of Skin::subPageSubtitle().

Since

1.35

Parameters

string	&$subpages	Subpage links HTML
Skin	$skin
OutputPage	$out

Returns

bool|void True or no return value to continue or false to abort. If true is returned, $subpages will be ignored and the rest of subPageSubtitle() will run. If false is returned, $subpages will be used instead of the HTML subPageSubtitle() generates.

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/skins/Hook/SkinSubPageSubtitleHook.php