MediaWiki  master
MediaWiki\Hook\UploadVerifyUploadHook Interface Reference

Stable to implement. More...

Inheritance diagram for MediaWiki\Hook\UploadVerifyUploadHook:

Public Member Functions

 onUploadVerifyUpload ( $upload, $user, $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.). More...
 

Detailed Description

Stable to implement.

Definition at line 13 of file UploadVerifyUploadHook.php.

Member Function Documentation

◆ onUploadVerifyUpload()

MediaWiki\Hook\UploadVerifyUploadHook::onUploadVerifyUpload (   $upload,
  $user,
  $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$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.
string$commentUpload log comment (also used as edit summary)
string$pageTextFile description page text (only used for new uploads)
array | MessageSpecifier&$errorOutput: 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

Implemented in MediaWiki\HookContainer\HookRunner.


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