Feature: #105833 - Extended page tree filter functionality

Description

The page tree is one of the central components in the TYPO3 backend, particularly for editors. However, in large installations, the page tree can quickly become overwhelming and difficult to navigate. To maintain a clear overview, the page tree can be filtered using basic terms, such as the page title or ID.

To enhance the filtering capabilities, the new PSR-14 \TYPO3\CMS\Backend\Tree\Repository\BeforePageTreeIsFilteredEvent has been introduced. This event allows developers to extend the filter's functionality and process the given search phrase in more advanced ways.

Using the Event, it is for example possible to evaluate a given URL or to add additional field matchings, like filter pages by their doktype or their configured backend layout.

The event provides the following member properties:

$searchParts:

The search parts to be used for filtering

$searchUids:

The uids to be used for filtering by a special search part, which

is added by Core always after listener evaluation

$searchPhrase

The complete search phrase, as entered by the user

$queryBuilder:

The current QueryBuilder

instance to provide context and to be used to create search parts

Example

The event listener class, using the PHP attribute #[AsEventListener] for registration, adds additional conditions to the filter.

use TYPO3\CMS\Backend\Tree\Repository\BeforePageTreeIsFilteredEvent;
use TYPO3\CMS\Core\Attribute\AsEventListener;
use TYPO3\CMS\Core\Database\Connection;

final class MyEventListener
{
    #[AsEventListener]
    public function removeFetchedPageContent(BeforePageTreeIsFilteredEvent $event): void
    {
        // Adds an additional UID to the filter
        $event->searchUids[] = 123;

        // Adds evaluation of doktypes to the filter
        if (preg_match('/doktype:([0-9]+)/i', $event->searchPhrase, $match)) {
            $doktype = $match[1];
            $event->searchParts = $event->searchParts->with(
                $event->queryBuilder->expr()->eq('doktype', $event->queryBuilder->createNamedParameter($doktype, Connection::PARAM_INT))
            );
        }
    }
}

Impact

With the new PSR-14 event \BeforePageTreeIsFilteredEvent, custom functionality and advanced evaluations can now be added to enhance the page tree filter.