wiki.techinc.nl/includes/diff/Hook/NewDifferenceEngineHook.php
apaskulin c44488f725 docs: Hook interface doc comment review
Edited doc comments for hook interfaces to improve
consistency and add type hints.

Bug: T246855
Change-Id: I38fa802463cd6f39bf5946dbbeb1b3ebaea604b2
2020-04-21 09:10:08 +10:00

25 lines
680 B
PHP

<?php
namespace MediaWiki\Diff\Hook;
use Title;
/**
* @stable for implementation
* @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 &$oldId Actual old ID to use in the diff
* @param int &$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 );
}