Handbuch:Hooks/APIEditBeforeSave

From mediawiki.org
This page is a translated version of the page Manual:Hooks/APIEditBeforeSave and the translation is 30% complete.
APIEditBeforeSave
Erhältlich ab Version 1.13.0
Entfernt in Version 1.34.0
Called right before saving an edit submitted through api.php?action=edit
Funktion definieren:
public static function onAPIEditBeforeSave( $editPage, $text, &$resultArr ) { ... }
Haken anbringen: In extension.json:
{
	"Hooks": {
		"APIEditBeforeSave": "MyExtensionHooks::onAPIEditBeforeSave"
	}
}
Angerufen von: Datei(en): api/ApiEditPage.php
Interface: APIEditBeforeSaveHook.php

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

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

Anmerkungen

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.