MediaWiki\Auth\Hook\AuthenticationAttemptThrottledHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onAuthenticationAttemptThrottled (string $type, ?string $username, ?string $ip)
	This hook is called when a Throttler has throttled an authentication attempt.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 12 of file AuthenticationAttemptThrottledHook.php.

Member Function Documentation

onAuthenticationAttemptThrottled()

MediaWiki\Auth\Hook\AuthenticationAttemptThrottledHook::onAuthenticationAttemptThrottled	(	string	$type,
		?string	$username,
		?string	$ip )

This hook is called when a Throttler has throttled an authentication attempt.

An authentication attempt includes account creation, logins, and temporary account auto-creation.

Since

1.43

Parameters

string	$type	The name of the authentication throttle that caused the throttling
string | null	$username	The username associated with the action that was throttled, or null if not relevant.
string | null	$ip	The IP used to make the action that was throttled, or null if not provided.

Returns

bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/auth/Hook/AuthenticationAttemptThrottledHook.php