Manual:フック/APIEditBeforeSave
 | この機能は、(バージョン 1.28.0 で廃止予定になったあと、) バージョン 1.34.0 で MediaWiki コアから除去されました。 この機能を使用するための代替方法については EditFilterMergedContent を参照してください。 |
| APIEditBeforeSave | |
|---|---|
| バージョン 1.13.0 から利用可能 バージョン 1.34.0 (Gerrit change 519797) で除去 Called right before saving an edit submitted through api.php?action=edit | |
| 関数の定義: | public static function onAPIEditBeforeSave( $editPage, $text, &$resultArr ) { ... }
|
| フックのアタッチ: | extension.json 内:
{
"Hooks": {
"APIEditBeforeSave": "MediaWiki\\Extension\\MyExtension\\Hooks::onAPIEditBeforeSave"
}
}
|
| 呼び出し元: | ファイル: api/ApiEditPage.php |
| インターフェイス: | APIEditBeforeSaveHook.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.