Feature: #96641 - New PSR-14 event for modifying links
See forge#96641
Description
A new PSR-14 event \TYPO3\
is added which allows PHP developers to modify any kind of link generated
by TYPO3's mighty "typolink()" functionality.
This PSR-14 event also supersedes the Url
logic
which allowed to modify mail URNs or external URLs, but not the
full anchor tag.
In addition, this PSR-14 event also replaces the
$GLOBALS
hook which was not executed at all times, and had a cumbersome API
to modify values.
It is also recommended to use the PSR-14 event instead of the global
getATagParams hook ($GLOBALS
)
to add additional attributes (see example below) to links.
All mentioned hooks have been removed.
Impact
By using the PSR-14 event, it is possible to add attributes to links to internal pages, or links to files, as the event contains the actual information of the link type with it.
As the PSR-14 event works with the Link
object it is possible
to modify or replace the LinkResult information instead of working with string
replacement functionality for adding, changing or removing attributes.
To register an event listener to the new event, use the following code in your
Services.
:
services:
MyCompany\MyPackage\TypoLink\LinkModifier:
tags:
- name: event.listener
identifier: 'myLoadedListener'
The corresponding event listener class:
use TYPO3\CMS\Frontend\Event\AfterLinkIsGeneratedEvent;
final class LinkModifier
{
public function __invoke(AfterLinkIsGeneratedEvent $event): void
{
$linkResult = $event->getLinkResult()->withAttribute('data-enable-lightbox', 'true');
$event->setLinkResult($linkResult);
}
}