Manual:Hooks/APIEditBeforeSave

APIEditBeforeSave
Available from version 1.13.0 Called right before saving an edit submitted through api.php?action=edit
Define function:	public static function onAPIEditBeforeSave( &$EditPage, $text, &$resultArr ) { ... }
Attach hook:	$wgHooks['APIEditBeforeSave'][] = 'MyExtensionHooks::onAPIEditBeforeSave';
Called from:	ApiEditPage.php

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

Details

• $EditPage: the EditPage object
• $text: the new text of the article (has yet to be saved)
• $resultArr: data in this array will be added to the API result

Notes

Return true to continue processing, return false to abort processing and reject the edit. If $resultArr was filled, the API will return an <edit result="Failure"> element with the contents of $resultArr added in. If $resultArr wasn't filled, the API will return an error message.

Language:	English  • 日本語