Vector\Hooks Class Reference

Presentation hook handlers for Vector skin. More...

Static Public Member Functions
static	onBeforePageDisplay (OutputPage $out, $sk)
	BeforePageDisplayMobile hook handler.
static	onSkinTemplateNavigation ( $sk, &$content_navigation)
	Upgrades Vector's watch action to a watchstar.
static	onGetPreferences (User $user, array &$prefs)
	Add Vector preferences to the user's Special:Preferences page directly underneath skins.
static	onPreferencesFormPreSave (array $formData, HTMLForm $form, User $user, &$result, $oldPreferences)
	Hook executed on user's Special:Preferences form save.
static	onLocalUserCreated (User $user, $isAutoCreated)
	Called one time when initializing a users preferences for a newly created account.
static	onOutputPageBodyAttributes (OutputPage $out, Skin $sk, &$bodyAttrs)
	Called when OutputPage::headElement is creating the body tag to allow skins and extensions to add attributes they might need to the body of the page.

Detailed Description

Presentation hook handlers for Vector skin.

Hook handler method names should be in the form of: on<HookName>()

Member Function Documentation

onBeforePageDisplay()

static Vector\Hooks::onBeforePageDisplay ( OutputPage  $out,   $sk  )

static

BeforePageDisplayMobile hook handler.

Make Legacy Vector responsive when $wgVectorResponsive = true

See also

https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay

Parameters

OutputPage	$out
SkinTemplate	$sk

onGetPreferences()

static Vector\Hooks::onGetPreferences ( User  $user, array &  $prefs  )

static

Add Vector preferences to the user's Special:Preferences page directly underneath skins.

Parameters

User	$user	User whose preferences are being modified.
array[]	&$prefs	Preferences description array, to be fed to a HTMLForm object.

onLocalUserCreated()

static Vector\Hooks::onLocalUserCreated ( User  $user,   $isAutoCreated  )

static

Called one time when initializing a users preferences for a newly created account.

Parameters

User	$user	Newly created user object.
bool	$isAutoCreated

onOutputPageBodyAttributes()

static Vector\Hooks::onOutputPageBodyAttributes ( OutputPage  $out, Skin  $sk, &  $bodyAttrs  )

static

Called when OutputPage::headElement is creating the body tag to allow skins and extensions to add attributes they might need to the body of the page.

Parameters

OutputPage	$out
Skin	$sk
string[]	&$bodyAttrs

onPreferencesFormPreSave()

static Vector\Hooks::onPreferencesFormPreSave ( array  $formData, HTMLForm  $form, User  $user, &  $result,   $oldPreferences  )

static

Hook executed on user's Special:Preferences form save.

This is used to convert the boolean presentation of skin version to a version string. That is, a single preference change by the user may trigger two writes: a boolean followed by a string.

Parameters

array	$formData	Form data submitted by user
HTMLForm	$form	A preferences form
User	$user	Logged-in user
bool	&$result	Variable defining is form save successful
array	$oldPreferences

onSkinTemplateNavigation()

static Vector\Hooks::onSkinTemplateNavigation (   $sk, &  $content_navigation  )

static

Upgrades Vector's watch action to a watchstar.

See also

https://www.mediawiki.org/wiki/Manual:Hooks/SkinTemplateNavigation

Parameters

SkinTemplate	$sk
array	&$content_navigation

---

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

• includes/Hooks.php