AfterSearchResultSetsAreGeneratedEvent
New in version 14.2 Feature: #109018 - PSR-14 event to modify indexed_search result sets
The PSR-14 event
\TYPO3\
allows complete search result sets to be modified. It is dispatched in
Search
after all result sets have been built. Listeners can manipulate complete
result sets in a single place, including pagination, rows, section data, and
category metadata.
Example: Use sliding window pagination for search results
The following listener replaces the default
Simple of every result set with a
Sliding, reusing the same
underlying paginator:
<?php
declare(strict_types=1);
namespace MyVendor\MyExtension\EventListener;
use TYPO3\CMS\Core\Attribute\AsEventListener;
use TYPO3\CMS\Core\Pagination\SimplePagination;
use TYPO3\CMS\Core\Pagination\SlidingWindowPagination;
use TYPO3\CMS\IndexedSearch\Event\AfterSearchResultSetsAreGeneratedEvent;
#[AsEventListener(identifier: 'my-extension/replace-search-result-pagination')]
final readonly class ReplaceSearchResultPaginationListener
{
public function __invoke(AfterSearchResultSetsAreGeneratedEvent $event): void
{
$resultSets = $event->getResultSets();
foreach ($resultSets as $key => $resultSet) {
if (($resultSet['pagination'] ?? null) instanceof SimplePagination) {
$resultSets[$key]['pagination'] = new SlidingWindowPagination(
$resultSet['pagination']->getPaginator(),
5,
);
}
}
$event->setResultSets($resultSets);
}
}
API
-
final class
AfterSearchResultSetsAreGeneratedEvent -
- Fully qualified name
-
\TYPO3\CMS\ Indexed Search\ Event\ After Search Result Sets Are Generated Event
Allows listeners to modify complete search result sets.
This event is dispatched in SearchController::searchAction() after all result sets have been created. Listeners can modify complete result sets, including pagination, rows, section data, and category metadata.