ModifyUrlForCanonicalTagEvent¶

Example¶

Registration of the event in the Services.yaml:

services:
  # Place here the default dependency injection configuration

  MyVendor\MyExtension\Seo\EventListener\MyEventListener:
    tags:
      - name: event.listener
        identifier: 'my-extension/modify-url-for-canonical-tag'

Changing the host of the current request and setting it as canonical:

<?php

declare(strict_types=1);

namespace MyVendor\MyExtension\Seo\EventListener;

use TYPO3\CMS\Seo\Event\ModifyUrlForCanonicalTagEvent;

final class MyEventListener
{
    public function __invoke(ModifyUrlForCanonicalTagEvent $event): void
    {
        // Note: $event->getUrl() is dispatched with the empty string value ''
        $currentUrl = $event->getRequest()->getUri();
        $newCanonical = $currentUrl->withHost('example.com');
        $event->setUrl((string)$newCanonical);
    }
}

API¶

class ModifyUrlForCanonicalTagEvent ¶

Fully qualified name

\TYPO3\CMS\Seo\Event\ModifyUrlForCanonicalTagEvent

PSR-14 event to alter (or empty) a canonical URL for the href="" attribute of a canonical URL.

getUrl ( ) ¶

Returns

string

setUrl ( string $url) ¶

param $url

the url

getRequest ( ) ¶

Returns

\Psr\Http\Message\ServerRequestInterface

getPage ( ) ¶

Returns

\TYPO3\CMS\Core\Domain\Page