MediaWiki master
MediaWiki\Storage\Hook\RevisionDataUpdatesHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions

 onRevisionDataUpdates ( $title, $renderedRevision, &$updates)
 This hook is called when constructing a list of DeferrableUpdate to be executed to record secondary data about a revision.
 

Detailed Description

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

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

Stability: stable
to implement

Definition at line 16 of file RevisionDataUpdatesHook.php.

Member Function Documentation

◆ onRevisionDataUpdates()

MediaWiki\Storage\Hook\RevisionDataUpdatesHook::onRevisionDataUpdates ( $title,
$renderedRevision,
& $updates )

This hook is called when constructing a list of DeferrableUpdate to be executed to record secondary data about a revision.

Since
1.35
Parameters
Title$titleTitle of the page the revision belongs to
RenderedRevision$renderedRevisionRenderedRevision object representing the new revision and providing access to the RevisionRecord as well as ParserOutput of that revision
DeferrableUpdate[]&$updatesList of DeferrableUpdate that can be manipulated by the hook handler
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: