MediaWiki  master
MediaWiki\Diff\Hook\DifferenceEngineMarkPatrolledRCIDHook Interface Reference

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

Inheritance diagram for MediaWiki\Diff\Hook\DifferenceEngineMarkPatrolledRCIDHook:

Public Member Functions

 onDifferenceEngineMarkPatrolledRCID (&$rcid, $differenceEngine, $change, $user)
 Use this hook to possibly change the rcid parameter. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 16 of file DifferenceEngineMarkPatrolledRCIDHook.php.

Member Function Documentation

◆ onDifferenceEngineMarkPatrolledRCID()

MediaWiki\Diff\Hook\DifferenceEngineMarkPatrolledRCIDHook::onDifferenceEngineMarkPatrolledRCID ( $rcid,
  $differenceEngine,
  $change,
  $user 
)

Use this hook to possibly change the rcid parameter.

For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions.

Since
1.35
Parameters
int&$rcidrc_id of the change or 0
DifferenceEngine$differenceEngine
RecentChange$change
User$userCurrent 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: