MediaWiki REL1_40
Public Member Functions | List of all members
MediaWiki\Hook\BlockIpCompleteHook Interface Reference
Hooks

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions

 onBlockIpComplete ( $block, $user, $priorBlock)
 This hook is called after an IP address or user is blocked.
 

Detailed Description

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

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

Stability: stable
to implement

Definition at line 15 of file BlockIpCompleteHook.php.

Member Function Documentation

◆ onBlockIpComplete()

MediaWiki\Hook\BlockIpCompleteHook::onBlockIpComplete ( $block,
$user,
$priorBlock )

This hook is called after an IP address or user is blocked.

Since
1.35
Parameters
DatabaseBlock$blockthe block object that was saved
User$userthe user who did the block (not the one being blocked)
?DatabaseBlock$priorBlockthe block object for the prior block, if there was one
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: