Vector
Vector is a skin for MediaWiki. Vector has been the default skin on all Wikimedia wikis since 2010.
Vector\Hooks Class Reference

Static Public Member Functions

static getVectorResourceLoaderConfig (ResourceLoaderContext $context, Config $config)
 Passes config variables to Vector (modern) ResourceLoader module. More...
 
static onBeforePageDisplay (OutputPage $out, $sk)
 BeforePageDisplayMobile hook handler. More...
 
static onSkinPageReadyConfig (ResourceLoaderContext $context, array &$config)
 SkinPageReadyConfig hook handler. More...
 
static onSkinTemplateNavigation ( $sk, &$content_navigation)
 Upgrades Vector's watch action to a watchstar. More...
 
static onGetPreferences (User $user, array &$prefs)
 Add Vector preferences to the user's Special:Preferences page directly underneath skins. More...
 
static onPreferencesFormPreSave (array $formData, HTMLForm $form, User $user, &$result, $oldPreferences)
 Hook executed on user's Special:Preferences form save. More...
 
static onLocalUserCreated (User $user, $isAutoCreated)
 Called one time when initializing a users preferences for a newly created account. More...
 
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. More...
 
static onMakeGlobalVariablesScript (&$vars, OutputPage $out)
 NOTE: Please use ResourceLoaderGetConfigVars hook instead if possible for adding config to the page. More...
 

Member Function Documentation

◆ getVectorResourceLoaderConfig()

static Vector\Hooks::getVectorResourceLoaderConfig ( ResourceLoaderContext  $context,
Config  $config 
)
static

Passes config variables to Vector (modern) ResourceLoader module.

Parameters
ResourceLoaderContext$context
Config$config
Returns
array

◆ 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$userUser whose preferences are being modified.
array[]&$prefsPreferences 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$userNewly created user object.
bool$isAutoCreated

◆ onMakeGlobalVariablesScript()

static Vector\Hooks::onMakeGlobalVariablesScript ( $vars,
OutputPage  $out 
)
static

NOTE: Please use ResourceLoaderGetConfigVars hook instead if possible for adding config to the page.

Adds config variables to JS that depend on current page/request.

Adds a config flag that can disable saving the VectorSidebarVisible user preference when the sidebar menu icon is clicked.

Parameters
array&$varsArray of variables to be added into the output.
OutputPage$outOutputPage instance calling the hook

◆ 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$formDataForm data submitted by user
HTMLForm$formA preferences form
User$userLogged-in user
bool&$resultVariable defining is form save successful
array$oldPreferences

◆ onSkinPageReadyConfig()

static Vector\Hooks::onSkinPageReadyConfig ( ResourceLoaderContext  $context,
array &  $config 
)
static

SkinPageReadyConfig hook handler.

Replace searchModule provided by skin.

Since
1.35
Parameters
ResourceLoaderContext$context
mixed[]&$configAssociative array of configurable options
Returns
void This hook must not abort, it must return no value

◆ 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: