MediaWiki\Page\Hook\PageDeleteHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

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

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()

MediaWiki\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	$page	Page being deleted.
Authority	$deleter	Who is deleting the page
string	$reason	Reason the page is being deleted
StatusValue	$status	Add any error here
bool	$suppress	Whether 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.

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/page/Hook/PageDeleteHook.php