Issue Task Closed

#109792Include site identifier in request cache tag

Soren Malling 05/07/26, 12:23 updated 09/08/26, 10:02

Description

To ease the clearing of cache of a single site, including the resolved site as a cachetag to `frontend.cache.collector` allows a integrator to use

$this->cache->flushByTag($siteIdentifier)

and clear the cache for that particular site.

In our usecase, we use it for clearing a single sites cache when changing a site setting. For example tracking id, labels etc)

Reviews 5

History 513

  1. Soren Malling commented and changed status Under Review Resolved done 0 % 100 % <span data-processor="relativetime" data-value="2026-05-20T20:20:11+00:00" > 05/20/26, 20:20 </span>

    Applied in changeset commit:b390dbe83e08ec37e731950c94ef6740ac35d1e0.

  2. Benjamin Franzke commented <span data-processor="relativetime" data-value="2026-05-28T07:59:21+00:00" > 05/28/26, 07:59 </span>

    Hey, this behaviour can be achieved via TypoScript or via a Middleware:

    Middleware example

    Classes/Middleware/SiteCacheTag.php:

    <?php
    declare(strict_types=1);
    
    namespace Bnf\MySite\Middleware;
    
    use Psr\Http\Message\ResponseInterface;
    use Psr\Http\Message\ServerRequestInterface;
    use Psr\Http\Server\MiddlewareInterface;
    use Psr\Http\Server\RequestHandlerInterface;
    use TYPO3\CMS\Core\Cache\CacheDataCollector;
    use TYPO3\CMS\Core\Cache\CacheTag;
    use TYPO3\CMS\Core\Site\Entity\SiteInterface;
    
    final readonly class SiteCacheTag implements MiddlewareInterface
    {
        public function process(
            ServerRequestInterface $request,
            RequestHandlerInterface $handler
        ): ResponseInterface {
            $response = $handler->handle($request);
    
            $cacheDataCollector = $this->getCacheDataCollector($request);
            $site = $this->getSite($request);
    
            if ($site !== null && count($cacheDataCollector?->getCacheEntries()) > 0) {
                $cacheDataCollector->addCacheTags(
                    new CacheTag('site_' . $site->getIdentifier())
                );
            }
    
            return $response;
        }
    
        private function getCacheDataCollector(
            ServerRequestInterface $request
        ): ?CacheDataCollector {
            return $request->getAttribute('frontend.cache.collector');
        }
    
        private function getSite(
            ServerRequestInterface $request
        ): ?SiteInterface {
            return $request->getAttribute('site');
        }
    }

    Configuration/RequestMiddlewares.php:

    <?php
    
    return [
        'frontend' => [
            'bnf/my-site/site-cache-tag' => [
                'target' => \Bnf\MySite\Middleware\SiteCacheTag::class,
                'after' => [
                    'typo3/cms-frontend/site',
                ],
            ],
        ],
    ];

    TypoScript example

    page = PAGE
    page {
      1779954161 = COA
      1779954161.stdWrap.addPageCacheTags = site_{site:identifier}
      1779954161.stdWrap.addPageCacheTags.insertData = 1
    }