MediaWiki\Hook\UploadStashFileHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onUploadStashFile (UploadBase $upload, User $user, ?array $props, &$error)
	This hook is called before a file is stashed (uploaded to stash).

Detailed Description

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

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

Stability: stable

to implement

Definition at line 16 of file UploadStashFileHook.php.

Member Function Documentation

onUploadStashFile()

MediaWiki\Hook\UploadStashFileHook::onUploadStashFile	(	UploadBase	$upload,
		User	$user,
		?array	$props,
		&	$error )

This hook is called before a file is stashed (uploaded to stash).

Note that code which has not been updated for MediaWiki 1.28 may not call this hook. If your extension absolutely, positively must prevent some files from being uploaded, use UploadVerifyFile or UploadVerifyUpload.

Since

1.35

Parameters

UploadBase	$upload	Instance of UploadBase with all info about the upload
User	$user	User uploading this file
array | null	$props	File properties, as returned by MWFileProps::getPropsFromPath(). Note this is not always guaranteed to be set, e.g. in test scenarios. Call MWFileProps::getPropsFromPath() yourself in case you need the information.
array | MessageSpecifier | null	&$error	Output: If the file stashing should be prevented, set this to the reason in the form of [ messagename, param1, param2, ... ] or a MessageSpecifier instance. (You might want to use ApiMessage to provide machine -readable details for the API.)

Returns

bool|void True or no return value to continue or false to abort

---

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

• includes/upload/Hook/UploadStashFileHook.php