MediaWiki REL1_35
Public Member Functions | List of all members
MediaWiki\User\Hook\UserIsLockedHook Interface Reference
Hooks

Stable to implement. More...

Inheritance diagram for MediaWiki\User\Hook\UserIsLockedHook:
Inheritance graph
[legend]

Public Member Functions

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

Detailed Description

Stable to implement.

Definition at line 11 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$userUser in question.
bool&$lockedSet 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: