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.
The PSR-14 event
\TYPO3\CMS\Backend\Form\Event\ModifyImageManipulationPreviewUrlEvent
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 element's crop variants will always be appended to the preview URL
as JSON-encoded string, using the cropVariants
parameter.
Example¶
<?php
declare(strict_types=1);
namespace MyVendor\MyExtension\Backend\EventListener;
use TYPO3\CMS\Backend\Form\Event\ModifyImageManipulationPreviewUrlEvent;
use TYPO3\CMS\Core\Attribute\AsEventListener;
#[AsEventListener(
identifier: 'my-extension/backend/modify-imagemanipulation-previewurl'
)]
final class MyEventListener
{
public function __invoke(ModifyImageManipulationPreviewUrlEvent $event): void
{
$event->setPreviewUrl('https://example.com/some/preview/url');
}
}
New in version 13.0: The PHP attribute \TYPO3\CMS\Core\Attribute\AsEventListener
has been
introduced to tag a PHP class as an event listener. Alternatively, or if you
need to be compatible with older TYPO3 versions, you can also register an
event listener via the Configuration/Services.yaml
file. Switch to
an older version of this page for an example or have a look at the section
Implementing an event listener in your extension.
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