MediaWiki master
MediaWiki\Page\Hook\PageUndeleteCompleteHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions

 onPageUndeleteComplete (ProperPageIdentity $page, Authority $restorer, string $reason, RevisionRecord $restoredRev, ManualLogEntry $logEntry, int $restoredRevisionCount, bool $created, array $restoredPageIds)
 This hook is called after a page is undeleted.

Detailed Description

This is a hook handler interface, see docs/

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

Stability: stable
to implement

Definition at line 17 of file PageUndeleteCompleteHook.php.

Member Function Documentation

◆ onPageUndeleteComplete()

MediaWiki\Page\Hook\PageUndeleteCompleteHook::onPageUndeleteComplete ( ProperPageIdentity  $page,
Authority  $restorer,
string  $reason,
RevisionRecord  $restoredRev,
ManualLogEntry  $logEntry,
int  $restoredRevisionCount,
bool  $created,
array  $restoredPageIds 

This hook is called after a page is undeleted.

ProperPageIdentity$pagePage that was undeleted.
Authority$restorerWho undeleted the page
string$reasonReason the page was undeleted
RevisionRecord$restoredRevLast revision of the undeleted page
ManualLogEntry$logEntryLog entry generated by the restoration
int$restoredRevisionCountNumber of revisions restored during the deletion
bool$createdWhether the undeletion result in a page being created
array$restoredPageIdsArray of all undeleted page IDs. This will have multiple page IDs if there was more than one deleted page with the same page title.
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: