MediaWiki  master
MediaWiki\Hook\FileDeleteCompleteHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\FileDeleteCompleteHook:

Public Member Functions

 onFileDeleteComplete ( $file, $oldimage, $article, $user, $reason)
 This hook is called when a file is deleted. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 16 of file FileDeleteCompleteHook.php.

Member Function Documentation

◆ onFileDeleteComplete()

MediaWiki\Hook\FileDeleteCompleteHook::onFileDeleteComplete (   $file,
  $oldimage,
  $article,
  $user,
  $reason 
)

This hook is called when a file is deleted.

Since
1.35
Parameters
LocalFile$fileReference to the deleted file
string$oldimageIn case of the deletion of an old image, the name of the old file
WikiFilePage$articleIn case all revisions of the file are deleted, a reference to the WikiFilePage associated with the file
User$userUser who performed the deletion
string$reason
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: