MediaWiki master
MediaWiki\Hook\FileUndeleteCompleteHook Interface Reference

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

Inherited by MediaWiki\Api\ApiHookRunner, and MediaWiki\HookContainer\HookRunner.

Public Member Functions

 onFileUndeleteComplete ( $title, $fileVersions, $user, $reason)
 This hook is called when a file is undeleted.
 

Detailed Description

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

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

Stability: stable
to implement

Definition at line 15 of file FileUndeleteCompleteHook.php.

Member Function Documentation

◆ onFileUndeleteComplete()

MediaWiki\Hook\FileUndeleteCompleteHook::onFileUndeleteComplete ( $title,
$fileVersions,
$user,
$reason )

This hook is called when a file is undeleted.

Since
1.35
Parameters
Title$titleTitle object for the file
int[]$fileVersionsArray of undeleted filearchive IDs. Empty if all versions were restored.
User$userUser who performed the undeletion
string$reason
Returns
bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\Api\ApiHookRunner, and MediaWiki\HookContainer\HookRunner.


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