MediaWiki\Hook\LocalFilePurgeThumbnailsHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onLocalFilePurgeThumbnails ( $file, $archiveName, $urls)
	This hook is called before thumbnails for a local file are purged.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 of file LocalFilePurgeThumbnailsHook.php.

Member Function Documentation

onLocalFilePurgeThumbnails()

MediaWiki\Hook\LocalFilePurgeThumbnailsHook::onLocalFilePurgeThumbnails	(		$file,
			$archiveName,
			$urls )

This hook is called before thumbnails for a local file are purged.

Since

1.35

Parameters

File	$file	The File of which the thumbnails are being purged
string | false	$archiveName	Name of an old file version or false if it's the current one
array	$urls	Urls to be purged

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/filerepo/Hook/LocalFilePurgeThumbnailsHook.php