WireUpload class

Saves uploads of single or multiple files, saving them to the destination path.

If the destination path does not exist, it will be created.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the WireUpload class also inherits all the methods and properties of: Wire.

Common

Name	Return	Summary
WireUpload::error() WireUpload::error($text) WireUpload::error($text, int $flags = 0)	`Wire` `WireUpload`	Record an error message
WireUpload::execute() WireUpload::execute() WireUpload::execute()	`array`	Execute/process the upload
WireUpload::getCompletedFilenames() WireUpload::getCompletedFilenames() WireUpload::getCompletedFilenames()	`array`	Get array of uploaded filenames
WireUpload::getErrors() WireUpload::getErrors() WireUpload::getErrors(bool $clear = false)	`array`	Get error messages
WireUpload::getOriginalFilenames() WireUpload::getOriginalFilenames() WireUpload::getOriginalFilenames()	`array`	Get unsanitized array of original filenames (basenames) indexed by completed basename
WireUpload::getOverwrittenFiles() WireUpload::getOverwrittenFiles() WireUpload::getOverwrittenFiles()	`array`	Get files that were overwritten (for overwrite mode only)
WireUpload::isAjaxUploading() WireUpload::isAjaxUploading() WireUpload::isAjaxUploading()	`bool`	Is an ajax upload request currently in progress?
WireUpload::setAllowAjax() WireUpload::setAllowAjax() WireUpload::setAllowAjax(bool $allowAjax = true)	`$this`	Set whether or not AJAX uploads are allowed
WireUpload::setDestinationPath() WireUpload::setDestinationPath(string $destinationPath) WireUpload::setDestinationPath(string $destinationPath)	`$this`	Set the destination path for uploaded files
WireUpload::setExtractArchives() WireUpload::setExtractArchives() WireUpload::setExtractArchives(bool $extract = true)	`$this`	Set whether or not ZIP files may be extracted
WireUpload::setLowercase() WireUpload::setLowercase() WireUpload::setLowercase(bool $lowercase = true)	`$this`	Set whether or not lowercase is enforced
WireUpload::setMaxFileSize() WireUpload::setMaxFileSize(int $bytes) WireUpload::setMaxFileSize(int $bytes)	`$this`	Set the max allowed uploaded file size
WireUpload::setMaxFiles() WireUpload::setMaxFiles(int $maxFiles) WireUpload::setMaxFiles(int $maxFiles)	`$this`	Set the max allowed number of uploaded files
WireUpload::setName() WireUpload::setName(string $name) WireUpload::setName(string $name)	`$this`	Set the upload field name (same as that provided to the constructor)
WireUpload::setOverwrite() WireUpload::setOverwrite(bool $overwrite) WireUpload::setOverwrite(bool $overwrite)	`$this`	Set whether or not overwrite is allowed
WireUpload::setOverwriteFilename() WireUpload::setOverwriteFilename(string $filename) WireUpload::setOverwriteFilename(string $filename)	`$this`	Set the filename that may be overwritten (i.e. myphoto.jpg) for single uploads only
WireUpload::setTargetFilename() WireUpload::setTargetFilename($filename) WireUpload::setTargetFilename($filename)	None	Set the target filename, only useful for single uploads
WireUpload::setValidExtensions() WireUpload::setValidExtensions(array $extensions) WireUpload::setValidExtensions(array $extensions)	`$this`	Set allowed file extensions
WireUpload::validateFilename() WireUpload::validateFilename(string $value) WireUpload::validateFilename(string $value, array $extensions = [])	`bool` `string`	Sanitize/validate a given filename
WireUpload::wired() WireUpload::wired() WireUpload::wired()	None	Wired to API

Additional methods and properties

In addition to the methods and properties above, WireUpload also inherits the methods and properties of these classes:

Wire

API reference based on ProcessWire core version 3.0.251