MediaWiki master
MediaWiki\Hook\UploadStashFileHook Interface Reference

This is a hook handler interface, see docs/ 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/

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.

UploadBase$uploadInstance of UploadBase with all info about the upload
User$userUser uploading this file
array | null$propsFile 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&$errorOutput: 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.)
bool|void True or no return value to continue or false to abort

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