1<?php
2
3namespace MediaWiki\User\Hook;
4
5use UserArrayFromResult;
6use Wikimedia\Rdbms\IResultWrapper;
7
8/**
9 * This is a hook handler interface, see docs/Hooks.md.
10 * Use the hook name "UserArrayFromResult" to register handlers implementing this interface.
11 *
12 * @stable to implement
13 * @ingroup Hooks
14 */
15interface UserArrayFromResultHook {
16	/**
17	 * This hook is called when creating an UserArray object from a database result.
18	 *
19	 * @since 1.35
20	 *
21	 * @param UserArrayFromResult|null &$userArray Set this to an object to override the default
22	 * @param IResultWrapper $res Database result used to create the object
23	 * @return bool|void True or no return value to continue or false to abort
24	 */
25	public function onUserArrayFromResult( &$userArray, $res );
26}
27