1	<?php
2
3	namespace MediaWiki\Hook;
4
5	use MediaWiki\Block\DatabaseBlock;
6	use MediaWiki\User\User;
7
8	/**
9	* This is a hook handler interface, see docs/Hooks.md.
10	* Use the hook name "BlockIp" to register handlers implementing this interface.
11	*
12	* @stable to implement
13	* @ingroup Hooks
14	*/
15	interface BlockIpHook {
16	/**
17	* This hook is called before an IP address or user is blocked.
18	*
19	* @since 1.35
20	*
21	* @param DatabaseBlock $block the Block object about to be saved
22	* @param User $user the user _doing_ the block (not the one being blocked)
23	* @param array &$reason if the hook is aborted, the error message to be returned in an array
24	* @return bool|void True or no return value to continue or false to abort
25	*/
26	public function onBlockIp( $block, $user, &$reason );
27	}