MediaWiki\Page\Hook\ArticleUndeleteHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onArticleUndelete ( $title, $create, $comment, $oldPageId, $restoredPages)
	This hook is called when one or more revisions of an article are restored.

Detailed Description

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

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

Deprecated

since 1.40, use PageUndeleteComplete instead. New hook follows consistent naming style and exposes variable similar to its counterpart PageDeleteComplete.

Definition at line 15 of file ArticleUndeleteHook.php.

Member Function Documentation

onArticleUndelete()

MediaWiki\Page\Hook\ArticleUndeleteHook::onArticleUndelete	(		$title,
			$create,
			$comment,
			$oldPageId,
			$restoredPages )

This hook is called when one or more revisions of an article are restored.

Since

1.35

Parameters

Title	$title	Title corresponding to the article restored
bool	$create	Whether or not the restoration caused the page to be created (i.e. it didn't exist before)
string	$comment	Comment associated with the undeletion
int	$oldPageId	ID of page previously deleted (from archive table). This ID will be used for the restored page.
array	$restoredPages	Set of page IDs that have revisions restored for this undelete, with keys set to page IDs and values set to 'true'

Returns

bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/Page/Hook/ArticleUndeleteHook.php