MediaWiki  master
MediaWiki\Hook\UsersPagerDoBatchLookupsHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\UsersPagerDoBatchLookupsHook:

Public Member Functions

 onUsersPagerDoBatchLookups ( $dbr, $userIds, &$cache, &$groups)
 This hook is called in UsersPager::doBatchLookups() More...
 

Detailed Description

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

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

Stable to implement

Definition at line 14 of file UsersPagerDoBatchLookupsHook.php.

Member Function Documentation

◆ onUsersPagerDoBatchLookups()

MediaWiki\Hook\UsersPagerDoBatchLookupsHook::onUsersPagerDoBatchLookups (   $dbr,
  $userIds,
$cache,
$groups 
)

This hook is called in UsersPager::doBatchLookups()

It is used to give extensions providing user group data from an alternate source a chance to add their data into the cache array so that things like global user groups are displayed correctly in Special:ListUsers.

Since
1.35
Parameters
IDatabase$dbrRead-only database handle
int[]$userIdsArray of user IDs whose groups we should look up
array&$cacheArray of user ID -> (array of internal group name (e.g. 'sysop') -> UserGroupMembership object)
array&$groupsArray of group name -> bool true mappings for members of a given user group
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: