File: FileDeleteCompleteHook.php

package info (click to toggle)
mediawiki 1%3A1.43.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 417,464 kB
  • sloc: php: 1,062,949; javascript: 664,290; sql: 9,714; python: 5,458; xml: 3,489; sh: 1,131; makefile: 64
file content (33 lines) | stat: -rw-r--r-- 961 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
<?php

namespace MediaWiki\Hook;

use LocalFile;
use MediaWiki\User\User;
use WikiFilePage;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "FileDeleteComplete" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface FileDeleteCompleteHook {
	/**
	 * This hook is called when a file is deleted.
	 *
	 * @since 1.35
	 *
	 * @param LocalFile $file Reference to the deleted file
	 * @param string|null $oldimage In case of the deletion of an old image, the name of the old file
	 * @param WikiFilePage|null $article In case all revisions of the file are deleted, a reference to
	 *   the WikiFilePage associated with the file
	 * @param User $user User who performed the deletion
	 * @param string $reason
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onFileDeleteComplete( $file, $oldimage, $article, $user,
		$reason
	);
}