Extension:PluggableAuth/Hooks/PluggableAuthUserAuthorization

From MediaWiki.org
Jump to navigation Jump to search
PluggableAuthUserAuthorization
Available from version 1.0 (Gerrit change 170132)
called to determine if the user is authorized to log in to the wiki
Define function:
public static function onPluggableAuthUserAuthorization( User $user, &$authorized ) { ... }
Attach hook:
$wgHooks['PluggableAuthUserAuthorization'][] = 'MyExtensionHooks::onPluggableAuthUserAuthorization';
Called from:File(s): PluggableAuth / includes/PluggableAuthLogin.php
Function(s): execute

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

Details[edit]

  • User $user: the User object
  • &$authorized: Boolean return value (true if authorized, false otherwise)

The possible return values for the handler are defined in Manual:Hooks. In particular, if there has not been an error, the hook function should return no value or null to allow other handlers to run or it should return false to prevent further handlers from running. It is, therefore, possible that the value of $authorized passed in may be false from a previous handler invocation that returned no value or null. The handler may choose to override that value or to leave it unchanged.