Extension:CentralAuth/Hooks/CentralAuthIsUIReloadRecommended

From mediawiki.org
Jump to navigation Jump to search
CentralAuthIsUIReloadRecommended
Available from version ???
Allows an extension to intercept the decision if a UI reload should be recommended
Define function:
public static function onCentralAuthIsUIReloadRecommended( User $user, bool &$recommendReload ) { ... }
Attach hook:
$wgHooks['CentralAuthIsUIReloadRecommended'][] = 'MyExtensionHooks::onCentralAuthIsUIReloadRecommended';
Called from:File(s): CentralAuth / includes/CentralAuthHooks.php
Function(s): isUIReloadRecommended

For more information about attaching hooks, see Manual:Hooks .
For examples of other extensions using this hook, see Category:CentralAuthIsUIReloadRecommended extensions.

Parameters[edit]

  • $user: An instance of User
  • &$recommendReload: A bool that defaults to false. This value can be overriden by the extension calling this hook.