MediaWiki\Hook\UploadVerifyUploadHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onUploadVerifyUpload (UploadBase $upload, User $user, ?array $props, $comment, $pageText, &$error)
	Use this hook to perform upload verification, based on both file properties like MIME type (same as UploadVerifyFile) and the information entered by the user (upload comment, file page contents etc.).

Detailed Description

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

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

Stability: stable

to implement

Definition at line 16 of file UploadVerifyUploadHook.php.

Member Function Documentation

onUploadVerifyUpload()

MediaWiki\Hook\UploadVerifyUploadHook::onUploadVerifyUpload	(	UploadBase	$upload,
		User	$user,
		?array	$props,
			$comment,
			$pageText,
		&	$error )

Use this hook to perform upload verification, based on both file properties like MIME type (same as UploadVerifyFile) and the information entered by the user (upload comment, file page contents etc.).

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.
string	$comment	Upload log comment (also used as edit summary)
string | false	$pageText	File description page text (only used for new uploads)
array | MessageSpecifier | null	&$error	Output: If the file upload 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/UploadVerifyUploadHook.php