ModifyPageLinkConfigurationEvent¶

New in version 12.0

This event has been introduced to serve as a more powerful and flexible alternative for the removed hook $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typolinkProcessing']['typolinkModifyParameterForPageLinks'].

The PSR-14 event \TYPO3\CMS\Frontend\Event\ModifyPageLinkConfigurationEvent is called after a page has been resolved, and includes arguments such as the generated fragment and the to-be-used query parameters.

The page to be linked to can also be modified to link to a different page.

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\Frontend\EventListener\MyEventListener:
    tags:
      - name: event.listener
        identifier: 'my-extension/modify-page-link-configuration'

Read how to configure dependency injection in extensions.

The corresponding event listener class:

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

<?php

declare(strict_types=1);

namespace MyVendor\MyExtension\Frontend\EventListener;

use TYPO3\CMS\Frontend\Event\ModifyPageLinkConfigurationEvent;

final class MyEventListener
{
    public function __invoke(ModifyPageLinkConfigurationEvent $event): void
    {
        // Do your magic here
    }
}

API¶

class \TYPO3\CMS\Frontend\Event\ ModifyPageLinkConfigurationEvent¶

A generic PSR 14 Event to allow modifying the incoming (and resolved) page when building a "page link".

This event allows Event Listener to change the page to be linked to, or add/remove possible query parameters / fragments to be generated.

getConfiguration ( ) ¶

returntype: array

setConfiguration ( array $configuration) ¶

param array $configuration: the configuration

getLinkDetails ( ) ¶

returntype: array

getPage ( ) ¶

returntype: array

setPage ( array $page) ¶

param array $page: the page

getQueryParameters ( ) ¶

returntype: array

setQueryParameters ( array $queryParameters) ¶

param array $queryParameters: the queryParameters

getFragment ( ) ¶

returntype: string

setFragment ( string $fragment) ¶

param string $fragment: the fragment

pageWasModified ( ) ¶

returntype: bool