This is a hook handler interface, see docs/Hooks.md. More...

Inheritance diagram for MediaWiki\Auth\Hook\AuthManagerLoginAuthenticateAuditHook:

Public Member Functions
	onAuthManagerLoginAuthenticateAudit ( $response, $user, $username, $extraData)
	This hook is called when a login attempt either succeeds or fails for a reason other than misconfiguration or session loss.

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "AuthManagerLoginAuthenticateAudit" to register handlers implementing this interface.

Member Function Documentation

MediaWiki\Auth\Hook\AuthManagerLoginAuthenticateAuditHook::onAuthManagerLoginAuthenticateAudit	(	$response,
		$user,
		$username,
		$extraData
	)

This hook is called when a login attempt either succeeds or fails for a reason other than misconfiguration or session loss.

No return data is accepted; this hook is for auditing only.

Parameters

AuthenticationResponse	$response	Response in either a PASS or FAIL state
User \| null	$user	User being authenticated against, or null if authentication failed before getting that far
string	$username	A guess at the username being authenticated, or null if we can't even determine that. When $user is not null, it can be in the form of <username><more info> (e.g. for bot passwords).
string[]	$extraData	Array (string => string) with extra information, intended to be added to log contexts. Fields it might include: appId: application ID, only if the login was with a bot password

The documentation for this interface was generated from the following file: