InputfieldImage class

One or more image 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 InputfieldImage class also inherits all the methods and properties of: InputfieldFile, Inputfield, WireData and Wire.

Common
For hooks

Common

Name	Return	Summary
InputfieldImage::adminThumbScale	`int`	for backwards compatibility only
InputfieldImage::clientQuality	`int`	Quality setting to use for client-side resize. 60=60%, 90=90%, etc. (default=90).
InputfieldImage::dimensionsByAspectRatio	`bool` `int`	Switch min-/maxWidth and min-/maxHeight restriction for portrait images
InputfieldImage::editFieldName	`string`	Field name to use for linking to image editor (default=current Inputfield name)
InputfieldImage::extensions	`string`	Space separated list of allowed image extensions (default="JPG JPEG GIF PNG")
InputfieldImage::focusMode	`string`	May be 'on', 'off', or 'zoom'
InputfieldImage::get() InputfieldImage::get(string $key) InputfieldImage::get(string $key)	`array` `bool` `mixed` `string` `null`	Get setting or attribute
InputfieldImage::getAdminThumb() InputfieldImage::getAdminThumb(Pageimage $img) InputfieldImage::getAdminThumb(Pageimage $img, bool $useSizeAttributes = true, bool $remove = false)	`array`	Get thumbnail image info
InputfieldImage::getConfigInputfields() InputfieldImage::getConfigInputfields() InputfieldImage::getConfigInputfields()	`InputfieldWrapper`	Configure field
InputfieldImage::gridMode	`string`	Default grid mode in admin, one of "grid", "left" or "list" (default="grid")
InputfieldImage::gridSize	`int`	squared size of the admin thumbnails (default=130)
InputfieldImage::imageSizerOptions	`array`	Options to pass along to the ImageSizer class. See /wire/config.php $imageSizerOptions for details.
InputfieldImage::itemClass	`string`	Space separated CSS classes for items rendered by this Inputfield. Generally you should append rather than replace.
InputfieldImage::maxHeight	`int` `string`	Max height for uploaded images, larger will be sized down (default='')
InputfieldImage::maxReject	`bool` `int`	Reject images that exceed max allowed size? (default=false)
InputfieldImage::maxSize	`float`	Maximum number of megapixels for client-side resize, i.e. 1.7 is ~1600x1000, alt. to maxWidth/maxHeight (default=0).
InputfieldImage::maxWidth	`int` `string`	Max width for uploaded images, larger will be sized down (default='')
InputfieldImage::minHeight	`int` `string`	Min height for uploaded images, smaller will be refused (default='')
InputfieldImage::minWidth	`int` `string`	Min width for uploaded images, smaller will be refused (default='')
InputfieldImage::okExtensions	`array`	Array of manually whitelisted extensions, for instance [ 'SVG' ] must be manually whitelisted if allowed. (default=[])
InputfieldImage::processInput() InputfieldImage::processInput(WireInputData $input) InputfieldImage::processInput(WireInputData $input)	`$this`	Process input
InputfieldImage::render() InputfieldImage::render() InputfieldImage::render()	`string`	Render Inputfield
InputfieldImage::renderItem() InputfieldImage::renderItem(Pageimage $pagefile, $id, $n) InputfieldImage::renderItem(Pageimage $pagefile, $id, $n)	`string`
InputfieldImage::renderList() InputfieldImage::renderList(Pageimages $value) InputfieldImage::renderList(Pageimages $value)	`string`
InputfieldImage::renderReady() InputfieldImage::renderReady() InputfieldImage::renderReady(Inputfield $parent = null, bool $renderValueMode = false)	`bool`	Called right before Inputfield render
InputfieldImage::renderSingleItem() InputfieldImage::renderSingleItem(Pageimage $pagefile, $id, $n) InputfieldImage::renderSingleItem(Pageimage $pagefile, $id, $n)	`string`
InputfieldImage::renderUpload() InputfieldImage::renderUpload(Pageimages $value) InputfieldImage::renderUpload(Pageimages $value)	`string`
InputfieldImage::resizeServer	`int` `bool`	Resize to max width/height at server? 1=Server-only, 0=Use client-side resize when possible (default=0).
InputfieldImage::useImageEditor	`int` `bool`	Whether or not the modal image editor is allowed for this field (default=true)

For hooks

These methods are only useful for hooking and should not be called directly.

Name	Return	Summary
InputfieldImage::buildTooltipData() InputfieldImage::buildTooltipData($pagefile) InputfieldImage::buildTooltipData($pagefile)	`array`	Build data for the tooltip that appears above the thumbnails
InputfieldImage::fileAdded() InputfieldImage::fileAdded(Pagefile $pagefile) InputfieldImage::fileAdded(Pagefile $pagefile)	(nothing)	Resize images to max width/height if specified in field config and image is larger than max
InputfieldImage::getFileActions() InputfieldImage::getFileActions($pagefile) InputfieldImage::getFileActions($pagefile)	`array`	Get array of actions (displayed in select dropdown) available for given Pagefile
InputfieldImage::getImageEditButtons() InputfieldImage::getImageEditButtons($pagefile, string $id, int $n, string $buttonClass) InputfieldImage::getImageEditButtons($pagefile, string $id, int $n, string $buttonClass)	`array`	Get array of buttons for image edit mode
InputfieldImage::getImageThumbnailActions() InputfieldImage::getImageThumbnailActions(Pageimage $pagefile, string $id, int $n, string $class) InputfieldImage::getImageThumbnailActions(Pageimage $pagefile, string $id, int $n, string $class)	`array`	Get the image thumbnail icon actions/links/buttons
InputfieldImage::processUnknownFileAction() InputfieldImage::processUnknownFileAction(Pageimage $pagefile, string $action, string $label) InputfieldImage::processUnknownFileAction(Pageimage $pagefile, string $action, string $label)	`bool` `null`	Called when a select dropdown action was received that InputfieldImage does not recognize (for hooking purposes)
InputfieldImage::renderAdditionalFields() InputfieldImage::renderAdditionalFields($pagefile, string $id, int $n) InputfieldImage::renderAdditionalFields($pagefile, string $id, int $n)	(nothing)	Render any additional fields (for hooks)
InputfieldImage::renderButtons() InputfieldImage::renderButtons($pagefile, string $id, int $n) InputfieldImage::renderButtons($pagefile, string $id, int $n)	`string`	Render buttons for image edit mode

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.236

One or more image uploads (sortable)

Common

For hooks

Additional methods and properties

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news