Manual:Hooks/SkinSubPageSubtitle

From Linux Web Expert

SkinSubPageSubtitle
<translate> Available from <tvar name=1><translate> version <tvar </tvar></translate>
Called before building the list of subpage links above a subpage
<translate> Define function:</translate>
public static function onSkinSubPageSubtitle( &$subpages, $skin, $out ) { ... }
<translate> Attach hook:</translate> <translate> In <tvar name=1>extension.json</tvar>:</translate>
{
	"Hooks": {
		"SkinSubPageSubtitle": "MediaWiki\\Extension\\MyExtension\\Hooks::onSkinSubPageSubtitle"
	}
}
<translate> Called from:</translate> <translate> File(s):</translate> Skin.php
<translate> Interface:</translate> SkinSubPageSubtitleHook.php

<translate> For more information about attaching hooks, see <tvar name=1>Manual:Hooks </tvar>.</translate>
<translate> For examples of extensions using this hook, see <tvar name=cat>Category:SkinSubPageSubtitle extensions</tvar>.</translate>

Details

Called before building the list of subpage links above a subpage (like this page).

Arguments

  • &$subpages: Put the subpage links HTML in this variable
  • $skin: Skin object (since 1.17.0)
  • $out: OutputPage object (since 1.21)

Return value

Return false if you want the content of $subpages to be displayed (this will override Skin::subPageSubtitle()'s functionality), return true if you want the default set of links to be generated (unless, of course, another hook overrides).