Manual:Hooks/GetUserBlock

From Linux Web Expert

GetUserBlock
<translate> Available from <tvar name=1><translate> version <tvar (Gerrit change 525305)</tvar></translate>
Modify the block found by the block manager.
<translate> Define function:</translate>
public static function onGetUserBlock( User $user, $ip, MediaWiki\Block\AbstractBlock &$block ) { ... }
<translate> Attach hook:</translate> <translate> In <tvar name=1>extension.json</tvar>:</translate>
{
	"Hooks": {
		"GetUserBlock": "MediaWiki\\Extension\\MyExtension\\Hooks::onGetUserBlock"
	}
}
<translate> Called from:</translate> <translate> File(s):</translate> block/BlockManager.php
<translate> Function(s):</translate> getUserBlock
<translate> Interface:</translate> GetUserBlockHook.php

<translate> For more information about attaching hooks, see <tvar name=1>Manual:Hooks </tvar>.</translate>
<translate> For examples of extensions using this hook, see <tvar name=cat>Category:GetUserBlock extensions</tvar>.</translate>


The block may be a single block or a composite block made from multiple blocks; the original blocks can be seen using MediaWiki\Block\CompositeBlock::getOriginalBlocks()

Details

  • $user: User object
  • $ip: IP address of user
  • &$block: MediaWiki\Block\AbstractBlock object