Manual:Hooks/UserArrayFromResult

From MediaWiki.org
Jump to navigation Jump to search
UserArrayFromResult
Available from version 1.13.0
called when creating an UserArray object from a database result.
Define function:
public static function onUserArrayFromResult( &$userArray, $res ) { ... }
Attach hook:

In extension.json:

{
	"Hooks": {
		"UserArrayFromResult": "MyExtensionHooks::onUserArrayFromResult"
	}
}

For MediaWiki ≤1.25:

$wgHooks['UserArrayFromResult'][] = 'MyExtensionHooks::onUserArrayFromResult';
Called from: File(s): UserArray.php

For more information about attaching hooks, see Manual:Hooks.
For examples of extensions using this hook, see Category:UserArrayFromResult extensions.

Details[edit]

  • &$userArray: set this to an object to override the default object returned
  • $res: database result used to create the object