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.

Detailed Description

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

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

Stability: 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	$file	Reference to the deleted file
string | null	$oldimage	In case of the deletion of an old image, the name of the old file
WikiFilePage | null	$article	In case all revisions of the file are deleted, a reference to the WikiFilePage associated with the file
User	$user	User 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:

• includes/Hook/FileDeleteCompleteHook.php