MediaWiki\User\Hook\UserIsLockedHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onUserIsLocked ( $user, &$locked)
	Use this hook to establish that a user is locked.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 of file UserIsLockedHook.php.

Member Function Documentation

onUserIsLocked()

MediaWiki\User\Hook\UserIsLockedHook::onUserIsLocked	(		$user,
		&	$locked )

Use this hook to establish that a user is locked.

See User::isLocked().

Since

1.35

Parameters

User	$user	User in question.
bool	&$locked	Set true if the user should be locked.

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/user/Hook/UserIsLockedHook.php