Contao Summit 2026 in Leipzig 15th and 16th October

storeFormData

The storeFormData hook is triggered before a submitted form is stored to the database. It passes the result set and the form object and expects the result set as return value.

Parameters

  1. array $data

    The result set that will be written to the database table.

  2. \Contao\Form $form

    The form instance.

Return Values

Return $data or an array of key => values that should be written to the database.

Example

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

use Contao\CoreBundle\DependencyInjection\Attribute\AsHook;
use Contao\Form;
use Contao\FrontendUser;
use Doctrine\DBAL\Connection;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;

#[AsHook('storeFormData')]
class StoreFormDataListener
{
    public function __construct(
        private readonly Connection $connection, 
        private readonly TokenStorageInterface $tokenStorage,
    ) {
    }

    public function __invoke(array $data, Form $form): array
    {
        $data['member'] = 0;

        $user = $this->tokenStorage->getToken()?->getUser();
       
        if (!$user instanceof FrontendUser) {
            return $data;
        }   

        if (!$this->columnExistsInTable('member', $form->targetTable)) {
            return $data;
        }

        // Also store the member ID who submitted the form
        $data['member'] = $user->id;

        return $data;
    }
    
    private function columnExistsInTable(string $columnName, string $tableName): bool
    {
        $columns = $this->connection->getSchemaManager()->listTableColumns($tableName);
            
        foreach ($columns as $column) {
            if ($column->getName() === $columnName) {
                return true;
            }
        }

        return false;
    }
}

References