ModifyHrefLangTagsEvent¶
New in version 10.3.
Event to alter the hreflang tags just before they get rendered.
The class TYPO3\CMS\Seo\HrefLang\HrefLangGenerator
has been
refactored to be a listener (identifier 'typo3-seo/hreflangGenerator') to the
newly introduced event. This way the system extension seo still provides
hreflang tags but it is now possible to register after or instead
of the implementation.
Example¶
An example implementation could look like this:
EXT:my_extension/Configuration/Services.yaml
services:
Vendor\MyExtension\HrefLang\EventListener\OwnHrefLang:
tags:
- name: event.listener
identifier: 'my-ext/ownHrefLang'
after: 'typo3-seo/hreflangGenerator'
event: TYPO3\CMS\Frontend\Event\ModifyHrefLangTagsEvent
With after
and before
, you can make sure your own listener is
executed after or before the given identifiers.
EXT:my_extension/Classes/HrefLang/EventListener/OwnHrefLang.php
namespace Vendor\MyExtension\HrefLang\EventListener;
use TYPO3\CMS\Frontend\Event\ModifyHrefLangTagsEvent;
final class OwnHrefLang
{
public function __invoke(ModifyHrefLangTagsEvent $event): void
{
$hrefLangs = $event->getHrefLangs();
$request = $event->getRequest();
// Do anything you want with $hrefLangs
$hrefLangs = [
'en-US' => 'https://example.org',
'nl-NL' => 'https://example.org/nl'
];
// Override all hrefLang tags
$event->setHrefLangs($hrefLangs);
// Or add a single hrefLang tag
$event->addHrefLang('de-DE', 'https://example.org/de');
}
}
API¶
- class TYPO3\CMS\Frontend\Event\ModifyHrefLangTagsEvent¶
Listeners to this Event will be able to modify the hreflang tags that will be generated. You can use this when you have an edge case language scenario and need to alter the default hreflang tags.
- getHrefLangs()¶
- Return type
array
- getRequest()¶
- Return type
Psr\Http\Message\ServerRequestInterface
- setHrefLangs(array $hrefLangs)¶
Set the hreflangs. This should be an array in format:
[
'en-US' => 'https://example.com', 'nl-NL' => 'https://example.com/nl'
]
- Parameters
$hrefLangs (
array
) -- the hrefLangs
- addHrefLang(string $languageCode, string $url)¶
Add a hreflang tag to the current list of hreflang tags
- Parameters
$languageCode (
string
) -- The language of the hreflang tag you would like to add. For example: nl-NL$url (
string
) -- The URL of the translation. For example: https://example.com/nl