Jump to content

Příručka:Háčky/APIEditBeforeSave

From mediawiki.org
This page is a translated version of the page Manual:Hooks/APIEditBeforeSave and the translation is 100% complete.
APIEditBeforeSave
Dostupné od verze 1.13.0
Odstraněno od verze 1.34.0 (Gerrit change 519797)
Voláno těsně před uložením úpravy odeslané přes api.php?action=edit
Definice funkce:
public static function onAPIEditBeforeSave( $editPage, $text, &$resultArr ) { ... }
Registrace háčku: V extension.json:
{
	"Hooks": {
		"APIEditBeforeSave": "MediaWiki\\Extension\\MyExtension\\Hooks::onAPIEditBeforeSave"
	}
}
Volá se z: Soubor/y: api/ApiEditPage.php
Rozhraní: APIEditBeforeSaveHook.php

Další informace o háčcích najdete na stránce Příručka:Háčky .
Chcete-li vědět, jaká rozšíření tento háček používají, podívejte se na stránku Category:APIEditBeforeSave extensions/cs.

Podrobnosti

  • $editPage: objekt EditPage
  • $text: nový text článku (zatím nebyl uložen)
  • $resultArr: data v tomto poli budou přidána do výsledku API

Poznámky

Vrátí hodnotu true pro pokračování ve zpracování, vrátí hodnotu false pro přerušení zpracování a odmítnutí úpravy. Pokud byl vyplněn element $resultArr, API vrátí element <edit result="Failure"> s přidaným obsahem proměnné $resultArr. Pokud nebyl vyplněn $resultArr, API vrátí chybový zprávě.