wiki.techinc.nl/includes/Hook/EditFilterHook.php
daniel 2e57447c58 Document hook names in hook interfaces.
Bug: T258665
Change-Id: Ifddbf57f8aa2e3eb0d5845601376cbafa08ed407
2020-09-27 12:03:12 +02:00

28 lines
769 B
PHP

<?php
namespace MediaWiki\Hook;
use EditPage;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "EditFilter" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface EditFilterHook {
/**
* Use this hook to perform checks on an edit.
*
* @since 1.35
*
* @param EditPage $editor Edit form (see includes/EditPage.php)
* @param string $text Contents of the edit box
* @param string $section Section being edited
* @param string &$error Error message to return
* @param string $summary Edit summary for page
* @return bool|void True or no return value to continue or false to abort
*/
public function onEditFilter( $editor, $text, $section, &$error, $summary );
}