Contao Summit 2026 in Leipzig 15th and 16th October

sqlGetFromDB

The sqlGetFromDB hook is triggered when parsing the current database definition. It passes the generated SQL definitions and expects the same as return value.

Parameters

  1. array $sql

    The compiled SQL definitions.

Return Values

Return $sql after adding your custom definitions.

Example

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

use Contao\CoreBundle\DependencyInjection\Attribute\AsHook;

#[AsHook('sqlGetFromDB')]
class SqlGetFromDBListener
{
    public function __invoke(array $sql): array
    {
        // Modify the array of SQL statements

        return $sql;
    }
}

References