prepareFormData

The prepareFormData hook is triggered after a form has been submitted, but before it is processed. It passes the form data array, the form labels array and the form object as arguments and does not expect a return value. This way the data can be changed or extended, prior to execution of actions like email distribution or data storage.

Parameters

  1. array $submittedData

    The user input from the form.

  2. array $labels

    The field labels of the form.

  3. array $fields

    The fields for this form as an array of \Contao\Widget instances.

  4. \Contao\Form $form

    The form instance.

Example

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

use Contao\CoreBundle\ServiceAnnotation\Hook;
use Contao\Form;
use Terminal42\ServiceAnnotationBundle\ServiceAnnotationInterface;

class PrepareFormDataListener implements ServiceAnnotationInterface
{
    /**
     * @Hook("prepareFormData")
     */
    public function onPrepareFormData(array &$submittedData, array $labels, array $fields, Form $form)
    {
        // This calculates a deadline from a given timestamp
        // and stores it as deadline in $submittedData.
        $submittedData['deadline'] = strtotime('+1 hour', $submittedData['tstamp']);
    }
}

References