Manual:Hooks/APIGetResultProperties

Category:MediaWiki hooks#APIGetResultProperties Category:Hooks added in MediaWiki 1.20.0#APIGetResultProperties Category:MediaWiki deprecated or obsolete features#APIGetResultProperties Category:Hooks removed in MediaWiki 1.24.0#APIGetResultProperties
APIGetResultProperties
Available from version 1.20.0
Removed in version 1.24.0Category:Removed hooks#APIGetResultProperties
Use this hook to modify the properties in a module's result.
Define function:
public static function onAPIGetResultProperties( ApiBase &$module, array &$properties ) { ... }
Attach hook: In extension.json:
{
	"Hooks": {
		"APIGetResultProperties": "MediaWiki\\Extension\\MyExtension\\Hooks::onAPIGetResultProperties"
	}
}
Called from: File(s): api/ApiBase.phpCategory:MediaWiki hooks included in ApiBase.php#APIGetResultProperties
Interface: APIGetResultPropertiesHook.php

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

Details

  • &$module: ApiBase object
  • &$properties: Array of properties
Category:Hooks added in MediaWiki 1.20.0 Category:Hooks removed in MediaWiki 1.24.0 Category:MediaWiki deprecated or obsolete features Category:MediaWiki hooks Category:MediaWiki hooks included in ApiBase.php Category:Removed hooks