MediaWiki\Permissions\Hook\UserGetRightsRemoveHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onUserGetRightsRemove ( $user, &$rights)
	This hook is called in PermissionManager::getUserPermissions().

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 of file UserGetRightsRemoveHook.php.

Member Function Documentation

onUserGetRightsRemove()

MediaWiki\Permissions\Hook\UserGetRightsRemoveHook::onUserGetRightsRemove	(		$user,
		&	$rights )

This hook is called in PermissionManager::getUserPermissions().

This hook overrides the UserGetRights hook. It can be used to remove rights from a user and ensure that they will not be reinserted by the other hook callbacks. This hook should not be used to add any rights; use UserGetRights instead.

Since

1.35

Parameters

User	$user	User to get rights for
string[]	&$rights	Current rights

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/Permissions/Hook/UserGetRightsRemoveHook.php