MediaWiki\User\Hook\UserPrivilegedGroupsHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onUserPrivilegedGroups (UserIdentity $userIdentity, array &$groups)
	This hook is called in UserGroupManager::getUserPrivilegedGroups().

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 of file UserPrivilegedGroupsHook.php.

Member Function Documentation

onUserPrivilegedGroups()

MediaWiki\User\Hook\UserPrivilegedGroupsHook::onUserPrivilegedGroups	(	UserIdentity	$userIdentity,
		array &	$groups )

This hook is called in UserGroupManager::getUserPrivilegedGroups().

Since

1.41 (also backported to 1.39.5 and 1.40.1)

Parameters

UserIdentity	$userIdentity	User identity to get groups for
string[]	&$groups	Current privileged groups

Returns

bool|void True or no return value to continue or false to abort

---

The documentation for this interface was generated from the following file:

• includes/user/Hook/UserPrivilegedGroupsHook.php