ModifyImageManipulationPreviewUrlEvent¶

New in version 12.0: This event serves as a direct replacement for the now removed $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['Backend/Form/Element/ImageManipulationElement']['previewUrl'] hook.

This event can be used to modify the preview url within the image manipulation element, used for example for the crop field of the sys_file_reference table.

As soon as a preview url is set, the image manipulation element will display a corresponding button in the footer of the modal window, next to the Cancel and Accept buttons. On click, the preview url will be opened in a new window.

Note

The elements crop variants will always be appended to the preview url as json encoded string, using the cropVariants parameter.

Example¶

Registration of the event in your extensions' Services.yaml:

EXT:my_extension/Configuration/Services.yaml¶

MyVendor\MyExtension\Backend\ModifyLinkExplanationEventListener:
  tags:
    - name: event.listener
      identifier: 'my-extension/backend/modify-imagemanipulation-previewurl'

The corresponding event listener class:

EXT:my_extension/Classes/Backend/ModifyLinkExplanationEventListener.php¶

use TYPO3\CMS\Backend\Form\Event\ModifyImageManipulationPreviewUrlEvent

final class ModifyLinkExplanationEventListener
{
    public function __invoke(ModifyImageManipulationPreviewUrlEvent $event): void
    {
        $event->setPreviewUrl('https://example.com/some/preview/url');
    }
}

API¶

class TYPO3\CMS\Backend\Form\Event\ModifyImageManipulationPreviewUrlEvent¶

Listeners to this Event will be able to modify the preview url, used in the ImageManipulation element

getDatabaseRow()¶

Return type: array

getFieldConfiguration()¶

Return type: array

getFile()¶

Return type: TYPO3\CMS\Core\Resource\File

getPreviewUrl()¶

Return type: string

setPreviewUrl(string $previewUrl)¶

Parameters

$previewUrl (string) -- the previewUrl