fix docu for ApiCheckCanExecute
authordaniel <daniel.kinzler@wikimedia.de>
Tue, 11 Sep 2012 13:16:39 +0000 (15:16 +0200)
committerdaniel <daniel.kinzler@wikimedia.de>
Tue, 11 Sep 2012 13:16:39 +0000 (15:16 +0200)
Change-Id: Ib9af835f3e775dd89a655b186923535d9bd01678

docs/hooks.txt

index 6105367..5207730 100644 (file)
@@ -320,12 +320,13 @@ $body: Body of the message
 Use this to extend core API modules.
 &$module: Module object
 
-'APICheckCanExecute': Called during ApiMain::checkCanExecute. Use to
+'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to
 further authenticate and authorize API clients before executing the
 module. Return false and set a message to cancel the request.
 $module: Module object
 $user: Current user
-&$message: API usage message to die with
+&$message: API usage message to die with, as a message key or array
+as accepted by ApiBase::dieUsageMsg.
 
 'APIEditBeforeSave': before saving a page with api.php?action=edit,
 after processing request parameters. Return false to let the request