Vector
Vector is a skin for MediaWiki. Vector has been the default skin on all Wikimedia wikis since 2010.
Loading...
Searching...
No Matches
MediaWiki\Skins\Vector\Hooks Class Reference
+ Inheritance diagram for MediaWiki\Skins\Vector\Hooks:
+ Collaboration diagram for MediaWiki\Skins\Vector\Hooks:

Public Member Functions

 __construct (Config $config, UserOptionsManager $userOptionsManager)
 
 onSkinPageReadyConfig (RL\Context $context, array &$config)
 SkinPageReadyConfig hook handler.
 
 onResourceLoaderSiteStylesModulePages ( $skin, &$pages)
 Adds MediaWiki:Vector.css as the skin style that controls classic Vector.
 
 onResourceLoaderSiteModulePages ( $skin, &$pages)
 Adds MediaWiki:Vector.css as the skin style that controls classic Vector.
 
 onGetPreferences ( $user, &$prefs)
 Adds Vector specific user preferences that can only be accessed via API.
 
 onLocalUserCreated ( $user, $isAutoCreated)
 Called one time when initializing a users preferences for a newly created account.
 
 onGetBetaFeaturePreferences (User $user, array &$betaFeatures)
 Register Vector 2022 beta feature to the beta features list.
 

Static Public Member Functions

static getActiveABTest (RL\Context $context, Config $config)
 
static getVectorSearchResourceLoaderConfig (RL\Context $context, Config $config)
 Generates config variables for skins.vector.search Resource Loader module (defined in skin.json).
 
static onSkinTemplateNavigation ( $sk, &$content_navigation)
 Upgrades Vector's watch action to a watchstar.
 

Member Function Documentation

◆ getActiveABTest()

static MediaWiki\Skins\Vector\Hooks::getActiveABTest ( RL\Context $context,
Config $config )
static
Parameters
RL\Context$context
Config$config
Returns
array

◆ getVectorSearchResourceLoaderConfig()

static MediaWiki\Skins\Vector\Hooks::getVectorSearchResourceLoaderConfig ( RL\Context $context,
Config $config )
static

Generates config variables for skins.vector.search Resource Loader module (defined in skin.json).

Parameters
RL\Context$context
Config$config
Returns
array<string,mixed>

◆ onGetBetaFeaturePreferences()

MediaWiki\Skins\Vector\Hooks::onGetBetaFeaturePreferences ( User $user,
array & $betaFeatures )

Register Vector 2022 beta feature to the beta features list.

Parameters
User$userUser the preferences are for
array&$betaFeatures

◆ onGetPreferences()

MediaWiki\Skins\Vector\Hooks::onGetPreferences ( $user,
& $prefs )

Adds Vector specific user preferences that can only be accessed via API.

Parameters
User$userUser whose preferences are being modified.
array[]&$prefsPreferences description array, to be fed to a HTMLForm object.

◆ onLocalUserCreated()

MediaWiki\Skins\Vector\Hooks::onLocalUserCreated ( $user,
$isAutoCreated )

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

Parameters
User$userNewly created user object.
bool$isAutoCreated

◆ onResourceLoaderSiteModulePages()

MediaWiki\Skins\Vector\Hooks::onResourceLoaderSiteModulePages ( $skin,
& $pages )

Adds MediaWiki:Vector.css as the skin style that controls classic Vector.

Parameters
string$skin
array&$pages

◆ onResourceLoaderSiteStylesModulePages()

MediaWiki\Skins\Vector\Hooks::onResourceLoaderSiteStylesModulePages ( $skin,
& $pages )

Adds MediaWiki:Vector.css as the skin style that controls classic Vector.

Parameters
string$skin
array&$pages

◆ onSkinPageReadyConfig()

MediaWiki\Skins\Vector\Hooks::onSkinPageReadyConfig ( RL\Context $context,
array & $config )

SkinPageReadyConfig hook handler.

Replace searchModule provided by skin.

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

◆ onSkinTemplateNavigation()

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

Upgrades Vector's watch action to a watchstar.

This is invoked inside SkinVector, not via skin registration, as skin hooks are not guaranteed to run last. This can possibly be revised based on the outcome of T287622.

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: