Manual:Hooks/APIQueryUsersTokens
 | This feature was removed completely in version 1.36.0 (after being deprecated in 1.24.0). This hook was removed in Gerrit change 625758. |
| APIQueryUsersTokens | |
|---|---|
| Available from version 1.15.0 Removed in version 1.36.0 (Gerrit change 625758) Use this hook to add custom token to list=users. | |
| Define function: | public static function onAPIQueryUsersTokens( &$tokenFunctions ) { ... }
|
| Attach hook: | In extension.json:
{
"Hooks": {
"APIQueryUsersTokens": "MediaWiki\\Extension\\MyExtension\\Hooks::onAPIQueryUsersTokens"
}
}
|
| Called from: | File(s): api/ApiQueryUsers.php |
| Interface: | APIQueryUsersTokensHook.php |
For more information about attaching hooks, see Manual:Hooks.
For examples of extensions using this hook, see Category:APIQueryUsersTokens extensions.
Details
- $tokenFunctions: array(action => callback)
Notes
Every token has an action, which will be used in the ustoken parameter and in the output (actiontoken="..."), and a callback function which should return the token, or false if the user isn't allowed to obtain it.
The prototype of the callback function is func($user) where $user is the User object. In the hook, just add your callback to the $tokenFunctions array and return true (returning false makes no sense)