Manual:Hooks/AutoAuthenticate

From mediawiki.org
Jump to navigation Jump to search
AutoAuthenticate
Available from version 1.5.4
Removed in version 1.13.0
Called to authenticate users on external/environmental means
Define function:
public static function onAutoAuthenticate( &$user ) { ... }
Attach hook: In extension.json:
{
	"Hooks": {
		"AutoAuthenticate": "MyExtensionHooks::onAutoAuthenticate"
	}
}
Called from: File(s): StubObject.php
Interface: AutoAuthenticateHook.php

For more information about attaching hooks, see Manual:Hooks .


The return result for this hook is not used by MediaWiki.

Details[edit]

  • $user: A user object to be setup by the external authentication extension. Once an extension creates and logs in a user, they should assign that user to this object.