MediaWiki REL1_37
MediaWiki\Diff\Hook\DifferenceEngineOldHeaderHook Interface Reference

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

Inheritance diagram for MediaWiki\Diff\Hook\DifferenceEngineOldHeaderHook:

Public Member Functions

 onDifferenceEngineOldHeader ( $differenceEngine, &$oldHeader, $prevlink, $oldminor, $diffOnly, $ldel, $unhide)
 Use this hook to change the $oldHeader variable, which contains information about the old revision, such as the revision's author, whether the revision was marked as a minor edit or not, etc.
 

Detailed Description

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

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

Stability: stable
to implement

Definition at line 14 of file DifferenceEngineOldHeaderHook.php.

Member Function Documentation

◆ onDifferenceEngineOldHeader()

MediaWiki\Diff\Hook\DifferenceEngineOldHeaderHook::onDifferenceEngineOldHeader (   $differenceEngine,
$oldHeader,
  $prevlink,
  $oldminor,
  $diffOnly,
  $ldel,
  $unhide 
)

Use this hook to change the $oldHeader variable, which contains information about the old revision, such as the revision's author, whether the revision was marked as a minor edit or not, etc.

Since
1.35
Parameters
DifferenceEngine$differenceEngine
string&$oldHeaderString containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more
string$prevlinkString containing the link to the previous revision (if any); also included in $oldHeader
string$oldminorString indicating if the old revision was marked as a minor edit
bool$diffOnlyBoolean parameter passed to DifferenceEngine::showDiffPage, indicating whether we should show just the diff; passed in as a query string parameter to the various URLs constructed here (i.e. $prevlink)
string$ldelRevisionDelete link for the old revision, if the current user is allowed to use the RevisionDelete feature
bool$unhideBoolean parameter indicating whether to show RevisionDeleted revisions
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: