MediaWiki  master
Page\Hook\ArticleUndeleteHook Interface Reference

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

Inheritance diagram for Page\Hook\ArticleUndeleteHook:

Public Member Functions

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

Detailed Description

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

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

Stable to implement

Definition at line 14 of file ArticleUndeleteHook.php.

Member Function Documentation

◆ onArticleUndelete()

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$titleTitle corresponding to the article restored
bool$createWhether or not the restoration caused the page to be created (i.e. it didn't exist before)
string$commentComment associated with the undeletion
int$oldPageIdID of page previously deleted (from archive table). This ID will be used for the restored page.
array$restoredPagesSet 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: