Manual:フック/APIEditBeforeSave

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Manual:Hooks/APIEditBeforeSave and the translation is 40% complete.

Other languages:
English • ‎中文 • ‎日本語
APIEditBeforeSave
version 1.13.0 から利用可能
Called right before saving an edit submitted through api.php?action=edit
関数の定義:
public static function onAPIEditBeforeSave( $editPage, $text, &$resultArr ) { ... }
フックのアタッチ:

extension.json 内:

{
	"Hooks": {
		"APIEditBeforeSave": "MyExtensionHooks::onAPIEditBeforeSave"
	}
}

MediaWiki 1.25 以前では:

$wgHooks['APIEditBeforeSave'][] = 'MyExtensionHooks::onAPIEditBeforeSave';
呼び出し元:ファイル: ApiEditPage.php

フックの付け方の詳細はManual:フックの情報を参照してください。
このフックを使用する拡張機能の例については、Category:APIEditBeforeSave extensions/ja を参照してください。

詳細

  • $editPage: EditPage オブジェクト
  • $text: the new text of the article (has yet to be saved)
  • $resultArr: data in this array will be added to the API result

注記

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.