MediaWiki master
MediaWiki\Page\Hook\PageDeleteCompleteHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions

 onPageDeleteComplete (ProperPageIdentity $page, Authority $deleter, string $reason, int $pageID, RevisionRecord $deletedRev, ManualLogEntry $logEntry, int $archivedRevisionCount)
 This hook is called after a page is deleted.
 

Detailed Description

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

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

Stability: stable
to implement

Definition at line 17 of file PageDeleteCompleteHook.php.

Member Function Documentation

◆ onPageDeleteComplete()

MediaWiki\Page\Hook\PageDeleteCompleteHook::onPageDeleteComplete ( ProperPageIdentity $page,
Authority $deleter,
string $reason,
int $pageID,
RevisionRecord $deletedRev,
ManualLogEntry $logEntry,
int $archivedRevisionCount )

This hook is called after a page is deleted.

Since
1.37
Parameters
ProperPageIdentity$pagePage that was deleted. This object represents state before deletion (e.g. $page->exists() will return true).
Authority$deleterWho deleted the page
string$reasonReason the page was deleted
int$pageIDID of the page that was deleted
RevisionRecord$deletedRevLast revision of the deleted page
ManualLogEntry$logEntryManualLogEntry used to record the deletion
int$archivedRevisionCountNumber of revisions archived during the deletion
Returns
true|void

Implemented in MediaWiki\HookContainer\HookRunner.


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