MediaWiki\User\Hook\UserEffectiveGroupsHook Interface Reference

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

Inheritance diagram for MediaWiki\User\Hook\UserEffectiveGroupsHook:

Public Member Functions
	onUserEffectiveGroups ( $user, &$groups)
	This hook is called in UserGroupManager::getUserEffectiveGroups().

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 of file UserEffectiveGroupsHook.php.

Member Function Documentation

onUserEffectiveGroups()

MediaWiki\User\Hook\UserEffectiveGroupsHook::onUserEffectiveGroups	(		$user,
		&	$groups )

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

Since

1.35

Parameters

User	$user	User to get groups for
string[]	&$groups	Current effective groups

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/UserEffectiveGroupsHook.php