AfterPagePreviewUriGeneratedEvent¶

New in version 12.0

This PSR-14 event replaces the $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['viewOnClickClass'] postProcess hook.

The \TYPO3\CMS\Backend\Routing\Event\AfterPagePreviewUriGeneratedEvent is executed in \TYPO3\CMS\Backend\Routing->buildUri(), after the preview URI has been built - or set by an event listener to BeforePagePreviewUriGeneratedEvent. It allows to overwrite the built preview URI. However, this event does not feature the possibility to modify the parameters, since this will not have any effect, as the preview URI is directly returned after event dispatching and no further action is done by the \TYPO3\CMS\Backend\Routing\PreviewUriBuilder.

Example¶

Registration of the event listener in the extension's Services.yaml:

EXT:my_extension/Configuration/Services.yaml

services:
  # Place here the default dependency injection configuration

  MyVendor\MyExtension\Backend\EventListener\MyEventListener:
    tags:
      - name: event.listener
        identifier: 'my-extension/backend/modify-preview-uri'

Read how to configure dependency injection in extensions.

The corresponding event listener class:

EXT:my_extension/Classes/Backend/EventListener/MyEventListener.php

<?php

declare(strict_types=1);

namespace MyVendor\MyExtension\Backend\EventListener;

use TYPO3\CMS\Backend\Routing\Event\AfterPagePreviewUriGeneratedEvent;

final class MyEventListener
{
    public function __invoke(AfterPagePreviewUriGeneratedEvent $event): void
    {
        // Add custom fragment to built preview URI
        $uri = $event->getPreviewUri();
        $uri = $uri->withFragment('#customFragment');
        $event->setPreviewUri($uri);
    }
}

API¶

class \TYPO3\CMS\Backend\Routing\Event\ AfterPagePreviewUriGeneratedEvent¶

Listeners to this event will be able to modify the page preview URI, which had been generated for a page in the frontend.

setPreviewUri ( Psr\\Http\\Message\\UriInterface $previewUri) ¶

param Psr\\Http\\Message\\UriInterface $previewUri: the previewUri

getPreviewUri ( ) ¶

returntype: Psr\Http\Message\UriInterface

getPageId ( ) ¶

returntype: int

getLanguageId ( ) ¶

returntype: int

getRootline ( ) ¶

returntype: array

getSection ( ) ¶

returntype: string

getAdditionalQueryParameters ( ) ¶

returntype: array

getContext ( ) ¶

returntype: TYPO3\CMS\Core\Context\Context

getOptions ( ) ¶

returntype: array