MediaWiki REL1_35
MediaWiki\Block\Hook\GetUserBlockHook Interface Reference

Stable to implement. More...

Inheritance diagram for MediaWiki\Block\Hook\GetUserBlockHook:

Public Member Functions

 onGetUserBlock ( $user, $ip, &$block)
 Use this hook to modify the block found by the block manager.

Detailed Description

Stable to implement.

Definition at line 12 of file GetUserBlockHook.php.

Member Function Documentation

◆ onGetUserBlock()

MediaWiki\Block\Hook\GetUserBlockHook::onGetUserBlock (   $user,

Use this hook to modify the block found by the block manager.

This may be a single block or a composite block made from multiple blocks; the original blocks can be seen using CompositeBlock::getOriginalBlocks().

User$userUser targeted by the block
string | null$ipIP of the current request if $user is the current user and they're not exempted from IP blocks. Null otherwise.
AbstractBlock | null&$blockUser's block, or null if none was found
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: