MediaWiki REL1_41
MediaWiki\Page\Hook\PageUndeleteHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions

 onPageUndelete (ProperPageIdentity $page, Authority $performer, string $reason, bool $unsuppress, array $timestamps, array $fileVersions, StatusValue $status)
 This hook is called before (part of) a page is undeleted.
 

Detailed Description

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

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

Stability: stable
to implement

Definition at line 16 of file PageUndeleteHook.php.

Member Function Documentation

◆ onPageUndelete()

MediaWiki\Page\Hook\PageUndeleteHook::onPageUndelete ( ProperPageIdentity $page,
Authority $performer,
string $reason,
bool $unsuppress,
array $timestamps,
array $fileVersions,
StatusValue $status )

This hook is called before (part of) a page is undeleted.

Since
1.37
Parameters
ProperPageIdentity$pagePage being undeleted.
Authority$performerWho is undeleting the page
string$reasonReason the page is being undeleted
bool$unsuppressWhether content is being unsuppressed or not
string[]$timestampsTimestamps of revisions that we're going to undelete. If empty, means all revisions.
int[]$fileVersionsVersions of a file that we're going to undelete. If empty, means all versions.
StatusValue$statusAdd any error here.
Returns
bool|void True or no return value to continue; false to abort, which also requires adding a fatal error to $status.

Implemented in MediaWiki\HookContainer\HookRunner.


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