MediaWiki\User\Hook\UserArrayFromResultHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onUserArrayFromResult (&$userArray, $res)
	This hook is called when creating an UserArray object from a database result.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 15 of file UserArrayFromResultHook.php.

Member Function Documentation

onUserArrayFromResult()

MediaWiki\User\Hook\UserArrayFromResultHook::onUserArrayFromResult	(	&	$userArray,
			$res )

This hook is called when creating an UserArray object from a database result.

Since

1.35

Parameters

UserArrayFromResult | null	&$userArray	Set this to an object to override the default
IResultWrapper	$res	Database result used to create the object

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