MinervaNeue
A responsive mobile first skin
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
MediaWiki\Minerva\Hooks Class Reference

Hook handlers for Minerva skin. More...

+ Inheritance diagram for MediaWiki\Minerva\Hooks:
+ Collaboration diagram for MediaWiki\Minerva\Hooks:

Public Member Functions

 onResourceLoaderRegisterModules (ResourceLoader $resourceLoader)
 ResourceLoaderRegisterModules hook handler.
 
 onFetchChangesList ( $user, $skin, &$list, $groups)
 Disable recent changes enhanced mode (table mode)
 
 onSpecialPageBeforeExecute ( $special, $subpage)
 Invocation of hook SpecialPageBeforeExecute.
 
 onUserLogoutComplete ( $user, &$inject_html, $oldName)
 UserLogoutComplete hook handler.
 
 onResourceLoaderGetConfigVars (array &$vars, $skin, Config $config)
 ResourceLoaderGetConfigVars hook handler.
 
 onOutputPageBodyAttributes ( $out, $skin, &$bodyAttrs)
 Modifies the <body> element's attributes.
 
 onSkinPageReadyConfig (Context $context, array &$config)
 SkinPageReadyConfig hook handler.
 

Static Public Member Functions

static onPreferencesGetLayout (&$useMobileLayout, $skin)
 PreferencesGetLayout hook handler.
 
static onMobileFrontendFeaturesRegistration ( $featureManager)
 Register mobile web beta features.
 
static onMobileFrontendBeforeDOM (MobileContext $mobileContext, MobileFormatter $formatter)
 MobileFrontendBeforeDOM hook handler that runs before the MobileFormatter executes.
 
static onRequestContextCreateSkinMobile (MobileContext $mobileContext, Skin $skin)
 BeforePageDisplayMobile hook handler.
 

Detailed Description

Hook handlers for Minerva skin.

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

Member Function Documentation

◆ onFetchChangesList()

MediaWiki\Minerva\Hooks::onFetchChangesList ( $user,
$skin,
& $list,
$groups )

Disable recent changes enhanced mode (table mode)

See also
https://www.mediawiki.org/wiki/Manual:Hooks/FetchChangesList
Parameters
User$user
Skin$skin
ChangesList | null&$list
ChangesListFilterGroup[]$groups
Returns
bool|null

◆ onMobileFrontendBeforeDOM()

static MediaWiki\Minerva\Hooks::onMobileFrontendBeforeDOM ( MobileContext $mobileContext,
MobileFormatter $formatter )
static

MobileFrontendBeforeDOM hook handler that runs before the MobileFormatter executes.

We use it to determine whether or not the talk page is eligible to be simplified (we want it only to be simplified when the MobileFormatter makes expandable sections).

Parameters
MobileContext$mobileContext
MobileFormatter$formatter

◆ onMobileFrontendFeaturesRegistration()

static MediaWiki\Minerva\Hooks::onMobileFrontendFeaturesRegistration ( $featureManager)
static

Register mobile web beta features.

See also
https://www.mediawiki.org/wiki/ Extension:MobileFrontend/MobileFrontendFeaturesRegistration
Parameters
FeaturesManager$featureManager

◆ onOutputPageBodyAttributes()

MediaWiki\Minerva\Hooks::onOutputPageBodyAttributes ( $out,
$skin,
& $bodyAttrs )

Modifies the <body> element's attributes.

By default, the class attribute is set to the output's "bodyClassName" property.

Parameters
OutputPage$out
Skin$skin
string[]&$bodyAttrs

◆ onPreferencesGetLayout()

static MediaWiki\Minerva\Hooks::onPreferencesGetLayout ( & $useMobileLayout,
$skin )
static

PreferencesGetLayout hook handler.

Use mobile layout in Special:Preferences

See also
https://www.mediawiki.org/wiki/Manual:Hooks/PreferencesGetLayout
Parameters
bool&$useMobileLayout
Skin | string$skin

◆ onRequestContextCreateSkinMobile()

static MediaWiki\Minerva\Hooks::onRequestContextCreateSkinMobile ( MobileContext $mobileContext,
Skin $skin )
static

BeforePageDisplayMobile hook handler.

Parameters
MobileContext$mobileContext
Skin$skin

◆ onResourceLoaderGetConfigVars()

MediaWiki\Minerva\Hooks::onResourceLoaderGetConfigVars ( array & $vars,
$skin,
Config $config )

ResourceLoaderGetConfigVars hook handler.

Used for setting JS variables which are pulled in dynamically with RL instead of embedded directly on the page with a script tag. These vars have a shorter cache-life than those in getJsConfigVars.

Parameters
array&$varsArray of variables to be added into the output of the RL startup module.
string$skin
Config$config

◆ onResourceLoaderRegisterModules()

MediaWiki\Minerva\Hooks::onResourceLoaderRegisterModules ( ResourceLoader $resourceLoader)

ResourceLoaderRegisterModules hook handler.

Registers:

  • EventLogging schema modules, if the EventLogging extension is loaded;
  • Modules for the Visual Editor overlay, if the VisualEditor extension is loaded; and
  • Modules for the notifications overlay, if the Echo extension is loaded.
See also
https://www.mediawiki.org/wiki/Manual:Hooks/ResourceLoaderRegisterModules
Parameters
ResourceLoader$resourceLoader

◆ onSkinPageReadyConfig()

MediaWiki\Minerva\Hooks::onSkinPageReadyConfig ( Context $context,
array & $config )

SkinPageReadyConfig hook handler.

Disable collapsible and sortable on page load

Parameters
Context$context
mixed[]&$configAssociative array of configurable options

◆ onSpecialPageBeforeExecute()

MediaWiki\Minerva\Hooks::onSpecialPageBeforeExecute ( $special,
$subpage )

Invocation of hook SpecialPageBeforeExecute.

We use this hook to ensure that login/account creation pages are redirected to HTTPS if they are not accessed via HTTPS and $wgSecureLogin == true - but only when using the mobile site.

Parameters
SpecialPage$special
string$subpage

◆ onUserLogoutComplete()

MediaWiki\Minerva\Hooks::onUserLogoutComplete ( $user,
& $inject_html,
$oldName )

UserLogoutComplete hook handler.

Resets skin options if a user logout occurs - this is necessary as the RequestContextCreateSkinMobile hook runs before the UserLogout hook.

Parameters
User$user
string&$inject_html
string$oldName
The documentation for this class was generated from the following file: