MediaWiki\User\Hook\UserIsBlockedGloballyHook Interface Reference

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

Inheritance diagram for MediaWiki\User\Hook\UserIsBlockedGloballyHook:

Public Member Functions
	onUserIsBlockedGlobally ( $user, $ip, &$blocked, &$block)
	Use this hook to establish that a user is blocked on all wikis.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 of file UserIsBlockedGloballyHook.php.

Member Function Documentation

onUserIsBlockedGlobally()

MediaWiki\User\Hook\UserIsBlockedGloballyHook::onUserIsBlockedGlobally	(		$user,
			$ip,
		&	$blocked,
		&	$block
	)

Use this hook to establish that a user is blocked on all wikis.

Since

1.35

Parameters

User	$user
string	$ip	User's IP address
bool	&$blocked	Whether the user is blocked, to be modified by the hook
null	&$block	The Block object, to be modified by the hook

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/user/Hook/UserIsBlockedGloballyHook.php