Manual:Hooks/APIEditBeforeSave

From MediaWiki.org
Jump to: navigation, search

Other languages:
English • ‎日本語 • ‎polski • ‎中文
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: File(s): ApiEditPage.php

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

Details[edit]

  • $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[edit]

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.