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

28 lines
848 B
PHP

<?php
namespace MediaWiki\Diff\Hook;
use Title;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "NewDifferenceEngine" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface NewDifferenceEngineHook {
/**
* This hook is called when a new DifferenceEngine object is made.
*
* @since 1.35
*
* @param Title|null $title Diff page title
* @param int|false|null &$oldId Actual old ID to use in the diff
* @param int|false|null &$newId Actual new Id to use in the diff (0 means current)
* @param int $old ?old= param value from the URL
* @param int $new ?new= param value from the URL
* @return bool|void True or no return value to continue or false to abort
*/
public function onNewDifferenceEngine( $title, &$oldId, &$newId, $old, $new );
}