MediaWiki  master
MediaWiki\Content\Hook\GetDifferenceEngineHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. More...

Inheritance diagram for MediaWiki\Content\Hook\GetDifferenceEngineHook:

Public Member Functions

 onGetDifferenceEngine ( $context, $old, $new, $refreshCache, $unhide, &$differenceEngine)
 This hook is called when getting a new difference engine interface object. More...
 

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "GetDifferenceEngine" to register handlers implementing this interface.

Stable to implement

Definition at line 15 of file GetDifferenceEngineHook.php.

Member Function Documentation

◆ onGetDifferenceEngine()

MediaWiki\Content\Hook\GetDifferenceEngineHook::onGetDifferenceEngine (   $context,
  $old,
  $new,
  $refreshCache,
  $unhide,
$differenceEngine 
)

This hook is called when getting a new difference engine interface object.

Use this hook to decorate or replace the default difference engine.

Since
1.35
Parameters
IContextSource$contextIContextSource context to be used for diff
int$oldRevision ID to show and diff with
int | string$newEither a revision ID or one of the strings 'cur', 'prev' or 'next'
bool$refreshCacheIf set, refreshes the diff cache
bool$unhideIf set, allow viewing deleted revs
DifferenceEngine&$differenceEngineDifference engine object to be used for the diff
Returns
bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.


The documentation for this interface was generated from the following file: