InputfieldImage

Properties marked * default from $config->adminThumbOptions and may be overridden on the Inputfield instance.

Inherited InputfieldFile properties such as maxFiles, maxFilesize, overwrite, descriptionRows, useTags, tagsList, noUpload, noAjax, and destinationPath also apply.

render()

Render the complete image input: image grid, editor controls, upload area, and hidden data fields.

echo $f->render();

renderList($value)

Render the thumbnail grid list. $value is usually a Pageimages collection.

$html = $f->renderList($page->images);

renderItem(Pageimage $pagefile, $id, $n)

Render one image item, including thumbnail, hover controls, edit fields, action select, sort input, replace input, rename input, and focus input.

$wire->addHookAfter('InputfieldImage::renderItem', function(HookEvent $event) {
    $event->return .= '<div class="my-extra-tool"></div>';
});

renderUpload($value)

Render the image upload button/drop target. The rendered input name receives [] unless the name already ends with ].

renderButtons(Pageimage $pagefile, $id, $n)

Render the crop/focus/variations button toolbar. Returns an empty string when useImageEditor is false.

renderAdditionalFields(Pageimage $pagefile, $id, $n)

Empty hook target for adding per-image markup below the description fields.

$wire->addHookAfter('InputfieldImage::renderAdditionalFields', function(HookEvent $event) {
    $image = $event->arguments(0); /** @var Pageimage $image */
    $event->return = "<p>{$image->width} x {$image->height}</p>";
});

getAdminThumb(Pageimage $img, $useSizeAttributes = true, $remove = false)

Return admin thumbnail data as an array with keys:

$thumb = $f->getAdminThumb($pageimage, false);
echo $thumb['markup'];

buildTooltipData(Pageimage $pagefile)

Return tooltip rows as [label, value] pairs. Default rows include dimensions, filesize, variation count, and indicators for hidden status, description, and tags when present.

$wire->addHookAfter('InputfieldImage::buildTooltipData', function(HookEvent $event) {
    $data = $event->return;
    $data[] = ['EXIF', 'Available'];
    $event->return = $data;
});

getImageEditButtons($pagefile, $id, $n, $buttonClass)

Return an array of crop, focus, and variations buttons. Hook after this method to add or remove editor buttons. Added in 3.0.212.

getImageThumbnailActions($pagefile, $id, $n, $class)

Return icon-only thumbnail hover actions. The default return value is an empty array; hooks may add actions. Added in 3.0.212.

getFileActions(Pageimage $pagefile)

Return actions for the image action dropdown, such as duplicate, hide/unhide, flip, rotate, grayscale, sepia, reduce 50%, and remove focus where applicable. The available actions depend on maxFiles, image extension, installed image engines, hidden status, and focus state.

$wire->addHookAfter('InputfieldImage::getFileActions', function(HookEvent $event) {
    $image = $event->arguments(0); /** @var Pageimage $image */
    $actions = $event->return;
    $actions['exif'] = 'Get EXIF data';
    $event->return = $actions;
});

processUnknownFileAction(Pageimage $pagefile, $action, $label)

Hook target for processing custom actions added through getFileActions(). Return true on success, false on failure, or null when not handled.

$wire->addHookAfter('InputfieldImage::processUnknownFileAction', function(HookEvent $event) {
    $image = $event->arguments(0); /** @var Pageimage $image */
    $action = $event->arguments(1);
    if($action === 'exif') {
        $event->message('EXIF action handled for ' . $image->name);
        $event->return = true;
    }
});

processInput(WireInputData $input)

Process uploads, deletions, descriptions, tags, sorting, focus values, and image actions. Image actions are processed only for non-AJAX saves.

processInputFile(WireInputData $input, Pageimage $pagefile, $n)

Process one image item. This extends InputfieldFile item processing with focus-point handling. Empty focus input resets to 50 50 0. Changed focus values rebuild variations.

fileAdded(Pagefile $pagefile)

Validate and post-process a newly uploaded image. Non-SVG images must have readable dimensions, are checked against min/max dimensions, and may be resized to max dimensions. SVG files bypass pixel-dimension validation and image editor operations.

• Access via $modules->get('InputfieldImage'), or let FieldtypeImage create it automatically for image fields.
• Client-side resize loads piexif.js and PWImageResizer.js when resize limits are configured and resizeServer=0.
• Focus values are stored on the Pageimage as top left zoom, for example 25 75 0.
• renderSingleItem() is deprecated and no longer used by core.
• SVG may be allowed by adding it to extensions and okExtensions, but SVG does not use the image editor, dimension validation, or raster image actions.
• For upload constraints, overwrite behavior, tags, descriptions, and custom Pagefile fields, see InputfieldFile.

Source files: wire/modules/Inputfield/InputfieldImage/InputfieldImage.module, wire/modules/Inputfield/InputfieldImage/config.php