getRootPageFromUrl

Details

This page shows version 4.x. The current version can be found here.

The getRootPageFromUrl hook is triggered when searching the current root page. It does not pass any parameters and expects a \Contao\PageModel instance as return value or null.

Note

Using the getRootPageFromUrl hook has been deprecated and will no longer work in Contao 5.0.

Return Values

Return a \Contao\PageModel instance if you want to override the default method for searching the root page.

Example

// src/EventListener/GetRootPageFromUrlListener.php
namespace App\EventListener;

use Contao\CoreBundle\DependencyInjection\Attribute\AsHook;

#[AsHook('getRootPageFromUrl')]
class GetRootPageFromUrlListener
{
    public function __invoke(): ?\Contao\PageModel
    {
        // Do something …
    }
}

References