MediaWiki\Hook\HistoryToolsHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\HistoryToolsHook:

Public Member Functions
	onHistoryTools ( $revRecord, &$links, $prevRevRecord, $userIdentity)
	Use this hook to override or extend the revision tools available from the page history view, i.e.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 15 of file HistoryToolsHook.php.

Member Function Documentation

onHistoryTools()

MediaWiki\Hook\HistoryToolsHook::onHistoryTools	(		$revRecord,
		&	$links,
			$prevRevRecord,
			$userIdentity
	)

Use this hook to override or extend the revision tools available from the page history view, i.e.

undo, rollback, etc.

Since

1.35

Parameters

RevisionRecord	$revRecord
string[]	&$links	Array of HTML links
RevisionRecord | null	$prevRevRecord	RevisionRecord object, next in line in page history, or null
UserIdentity	$userIdentity	Current user

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:

• includes/actions/Hook/HistoryToolsHook.php