MediaWiki\RecentChanges\Hook\RecentChangesPurgeQueryHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onRecentChangesPurgeQuery ( $query, &$callbacks)
	This hook is called by RecentChangesUpdateJob before recentchanges rows are deleted.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 of file RecentChangesPurgeQueryHook.php.

Member Function Documentation

onRecentChangesPurgeQuery()

MediaWiki\RecentChanges\Hook\RecentChangesPurgeQueryHook::onRecentChangesPurgeQuery	(		$query,
		&	$callbacks )

This hook is called by RecentChangesUpdateJob before recentchanges rows are deleted.

It can be used to add fields to the query, and to register a callback function which will be called when the query is done, after the rows have been deleted, but before the end of the transaction.

Since

1.45

Parameters

SelectQueryBuilder	$query	A query on the recentchanges table to which fields and joins can be added.
callable[]	&$callbacks	Out parameter specifying a list of callbacks. The handler should append to the list to receive the result of the potentially modified query. The callbacks will be called with one parameter: a \Wikimedia\Rdbms\IResultWrapper. The callbacks will not be called if there were no rows in the result set.

Returns

void This hook must not abort, it must return no value

Implemented in MediaWiki\HookContainer\HookRunner.

---

The documentation for this interface was generated from the following file:

• includes/RecentChanges/Hook/RecentChangesPurgeQueryHook.php