MediaWiki\Hook\UnblockUserHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\UnblockUserHook:

Public Member Functions
	onUnblockUser ( $block, $user, &$reason)
	This hook is called before an IP address or user is unblocked.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 15 of file UnblockUserHook.php.

Member Function Documentation

onUnblockUser()

MediaWiki\Hook\UnblockUserHook::onUnblockUser	(		$block,
			$user,
		&	$reason
	)

This hook is called before an IP address or user is unblocked.

Since

1.35

Parameters

DatabaseBlock	$block	The Block object about to be saved
User	$user	The user performing the unblock (not the one being unblocked)
array	&$reason	If the hook is aborted, the error message to be returned in an array

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:

• includes/specials/Hook/UnblockUserHook.php