MediaWiki  master
Page\Hook\PageDeleteHook Interface Reference

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

Inheritance diagram for Page\Hook\PageDeleteHook:

Public Member Functions

 onPageDelete (ProperPageIdentity $page, Authority $deleter, string $reason, StatusValue $status, bool $suppress)
 This hook is called before a page is deleted. More...
 

Detailed Description

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

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

Stability: stable
to implement

Definition at line 16 of file PageDeleteHook.php.

Member Function Documentation

◆ onPageDelete()

Page\Hook\PageDeleteHook::onPageDelete ( ProperPageIdentity  $page,
Authority  $deleter,
string  $reason,
StatusValue  $status,
bool  $suppress 
)

This hook is called before a page is deleted.

Since
1.37
Parameters
ProperPageIdentity$pagePage being deleted.
Authority$deleterWho is deleting the page
string$reasonReason the page is being deleted
StatusValue$statusAdd any error here
bool$suppressWhether this is a suppression deletion or not
Returns
bool|void True or no return value to continue; false to abort, which also requires adding a fatal error to $status.

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