wiki.techinc.nl/includes/diff/Hook/NewDifferenceEngineHook.php
Tim Starling f5aaf75ad1 Automatically generated hook interfaces
Add hook interfaces which were generated by a script which parses
hooks.txt and identifies caller namespaces and directories.

Hook interfaces are mostly placed in a Hook/ subdirectory
relative to the caller location. When there are callers in multiple
directories, a "primary" caller was manually selected. The exceptions to
this are:

* The source root, maintenance and tests, which use includes/Hook. Test
  hooks need to be autoloadable in a non-test request so that
  implementing test interfaces in a generic handler will not fail.
* resources uses includes/resourceloader/Hook
* The following third-level subdirectories had their hooks placed in
  the parent ../Hook:
    * includes/filerepo/file
    * includes/search/searchwidgets
    * includes/specials/forms
    * includes/specials/helpers
    * includes/specials/pagers

Parameters marked as legacy references in hooks.txt are passed
by value in the interfaces.

Bug: T240307
Change-Id: I6efe2e7dd1f0c6a3d0f4d100a4c34e41f8428720
2020-04-20 13:31:05 +10:00

23 lines
693 B
PHP

<?php
namespace MediaWiki\Diff\Hook;
/**
* @stable for implementation
* @ingroup Hooks
*/
interface NewDifferenceEngineHook {
/**
* Called when a new DifferenceEngine object is made
*
* @since 1.35
*
* @param ?mixed $title the diff page title (nullable)
* @param ?mixed &$oldId the actual old Id to use in the diff
* @param ?mixed &$newId the actual new Id to use in the diff (0 means current)
* @param ?mixed $old the ?old= param value from the url
* @param ?mixed $new the ?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 );
}