InputfieldFile class

One or more file uploads (sortable)

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

Common

Name	Return	Summary
InputfieldFile::descriptionRows	`int`	Number of rows for description field (default=1, 0=disable)
InputfieldFile::destinationPath	`string`	Destination path for uploaded file
InputfieldFile::extensions	`string`	Allowed file extensions, space separated
InputfieldFile::extractMetadata() InputfieldFile::extractMetadata(Pagefile $pagefile) InputfieldFile::extractMetadata(Pagefile $pagefile, array $metadata = array)	`array`	)
InputfieldFile::fileAdded() InputfieldFile::fileAdded(Pagefile $pagefile) InputfieldFile::fileAdded(Pagefile $pagefile)	(nothing)
InputfieldFile::get() InputfieldFile::get($key) InputfieldFile::get($key)	`mixed` `null`	Get a property or attribute from the Inputfield
InputfieldFile::getConfigInputfields() InputfieldFile::getConfigInputfields() InputfieldFile::getConfigInputfields()	`InputfieldWrapper`	Configuration settings for InputfieldFile
InputfieldFile::getDisplayBasename() InputfieldFile::getDisplayBasename(Pagefile $pagefile) InputfieldFile::getDisplayBasename(Pagefile $pagefile, int $maxLength = 25)	`string`	Get a basename for the file, possibly shortened, suitable for display in InputfieldFileList
InputfieldFile::getItemInputfields() InputfieldFile::getItemInputfields() InputfieldFile::getItemInputfields($item = null)	`bool` `InputfieldWrapper`	Get custom Inputfields for editing given Pagefile
InputfieldFile::getWireUpload() InputfieldFile::getWireUpload() InputfieldFile::getWireUpload()	`WireUpload`	Return the current WireUpload instance or create a new one if not yet created
InputfieldFile::isEmpty() InputfieldFile::isEmpty() InputfieldFile::isEmpty()	`bool`	Per Inputfield interface, returns true when this field is empty
InputfieldFile::itemClass	`string`	Class name(s) for each file item (default=InputfieldFileItem ui-widget ui-widget-content)
InputfieldFile::maxFiles	`int`	Maximum number of files allowed
InputfieldFile::maxFilesize	`int`	Maximum file size
InputfieldFile::noAjax	`bool` `int`	Set to true or 1 to disable ajax uploading
InputfieldFile::noCollapseItem	`bool` `int`	Set to true to disable collapsed items (like for LanguageTranslator tool or other things that add tools to files)
InputfieldFile::noCustomButton	`bool` `int`	Set to true to disable use of the styled <input type='file'>
InputfieldFile::noLang	`bool` `int`	Set to true or 1 to disable multi-language descriptions
InputfieldFile::noShortName	`bool` `int`	Set to true to disable shortened filenames in output
InputfieldFile::noUpload	`bool` `int`	Set to true or 1 to disable uploading to this field
InputfieldFile::okExtensions	`array`	File extensions that are whitelisted if any in $extensions are problematic. (3.0.167+)
InputfieldFile::overwrite	`bool` `int`	Whether or not overwrite mode is enabled
InputfieldFile::processInput() InputfieldFile::processInput(WireInputData $input) InputfieldFile::processInput(WireInputData $input)	`self`	Process input
InputfieldFile::processInputAddFile() InputfieldFile::processInputAddFile($filename) InputfieldFile::processInputAddFile($filename)	`Pagefile` `null`
InputfieldFile::processInputDeleteFile() InputfieldFile::processInputDeleteFile(Pagefile $pagefile) InputfieldFile::processInputDeleteFile(Pagefile $pagefile)	(nothing)
InputfieldFile::processInputFile() InputfieldFile::processInputFile(WireInputData $input, Pagefile $pagefile, $n) InputfieldFile::processInputFile(WireInputData $input, Pagefile $pagefile, $n)	`bool`
InputfieldFile::processItemInputfields() InputfieldFile::processItemInputfields(Pagefile $pagefile, InputfieldWrapper $inputfields, $id, WireInputData $input) InputfieldFile::processItemInputfields(Pagefile $pagefile, InputfieldWrapper $inputfields, $id, WireInputData $input)	`bool`
InputfieldFile::render() InputfieldFile::render() InputfieldFile::render()	`string`	Render Inputfield input
InputfieldFile::renderItem() InputfieldFile::renderItem($pagefile, $id, $n) InputfieldFile::renderItem($pagefile, $id, $n)	`string`
InputfieldFile::renderList() InputfieldFile::renderList($value) InputfieldFile::renderList($value)	`string`
InputfieldFile::renderReady() InputfieldFile::renderReady() InputfieldFile::renderReady($parent = null, bool $renderValueMode = false)	`bool`	Render ready
InputfieldFile::renderUpload() InputfieldFile::renderUpload($value) InputfieldFile::renderUpload($value)	`string`
InputfieldFile::renderValue() InputfieldFile::renderValue() InputfieldFile::renderValue()	`string`	Render Inputfield value
InputfieldFile::set() InputfieldFile::set($key, $value) InputfieldFile::set($key, $value)	`Inputfield` `WireData`	Set a property or attribute to the Inputfield
InputfieldFile::setAttribute() InputfieldFile::setAttribute($key, $value) InputfieldFile::setAttribute($key, $value)	`Inputfield` `InputfieldFile`	Set an attribute
InputfieldFile::setMaxFilesize() InputfieldFile::setMaxFilesize($filesize) InputfieldFile::setMaxFilesize($filesize)	`$this`	Set the max file size in bytes or use string like "30m", "2g" "500k"
InputfieldFile::setParent() InputfieldFile::setParent(InputfieldWrapper $parent) InputfieldFile::setParent(InputfieldWrapper $parent)	`$this`	Set the parent of this Inputfield
InputfieldFile::tagsList	`string`	Predefined tags
InputfieldFile::unzip	`bool` `int`	Whether or not unzip is enabled
InputfieldFile::uploadOnlyMode	`int`	Set to true or 1 to disable existing file list display, or 2 to also prevent file from having 'temp' status.
InputfieldFile::useTags	`bool`	Whether or not tags are enabled
InputfieldFile::value	`Pagefiles` `Pagefile` `null`

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.236

One or more file uploads (sortable)

Common

Additional methods and properties

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news