Manual:Hooks/DifferenceEngineOldHeader

From MediaWiki.org
Jump to navigation Jump to search
DifferenceEngineOldHeader
Available from version 1.29.0 (Gerrit change 298026)
Allows extensions 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.
Define function:
public static function onDifferenceEngineOldHeader( $differenceEngine, &$oldHeader, $prevlink, $oldminor, $diffOnly, $ldel, $unhide ) { ... }
Attach hook:

In extension.json:

{
	"Hooks": {
		"DifferenceEngineOldHeader": "MyExtensionHooks::onDifferenceEngineOldHeader"
	}
}

For MediaWiki ≤1.25:

$wgHooks['DifferenceEngineOldHeader'][] = 'MyExtensionHooks::onDifferenceEngineOldHeader';
Called from: File(s): DifferenceEngine.php
Function(s): showDiffPage

For more information about attaching hooks, see Manual:Hooks.
For examples of extensions using this hook, see Category:DifferenceEngineOldHeader extensions.

Details[edit]

  • $differenceEngine: DifferenceEngine object
  • &$oldHeader: The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more
  • $prevlink: String containing the link to the previous revision (if any); also included in $oldHeader
  • $oldminor: String indicating if the old revision was marked as a minor edit
  • $diffOnly: Boolean 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)
  • $ldel: RevisionDelete link for the old revision, if the current user is allowed to use the RevisionDelete feature
  • $unhide: Boolean parameter indicating whether to show RevisionDeleted revisions