Confirmation finisher

A basic finisher that outputs a given text or a content element, respectively.

Table of contents

Important

Finishers are executed in the order defined in your form definition.

See Finisher execution order.

Options of the confirmation finisher

This finisher outputs a given text after the form has been submitted.

The settings of the finisher are as follows:

message

Type: string
Default: The form has been submitted.

Displays this message if the contentElementUid is not set.

contentElementUid

Type: int
Default: 0

Renders the content element with the ID supplied here.

Confirmation finisher in the YAML form definition

A basic finisher that outputs a given text or a content element, respectively.

Usage within form definition for the case, you want to use a given text.

public/fileadmin/forms/my_form.yaml

identifier: example-form
label: 'example'
type: Form

finishers:
  -
    identifier: Confirmation
    options:
      message: 'Thx for using TYPO3'
  # ...

Usage within form definition for the case, you want to output a content element.

public/fileadmin/forms/my_form.yaml

identifier: example-form
label: 'example'
type: Form

finishers:
  -
    identifier: Confirmation
    options:
      contentElementUid: 42
  #...

Usage of the confirmation finisher in PHP code

Developers can create a confirmation finisher by using the key Confirmation:

<?php

use TYPO3\CMS\Form\Domain\Model\FormDefinition;
class SomeClass
{
    private function addConfirmationnFinisherWithMessage(FormDefinition $formDefinition, string $message)
    {
        $formDefinition->createFinisher('Confirmation', [
            'message' => $message,
        ]);
    }
    private function addConfirmationnFinisherWithContentElement(FormDefinition $formDefinition, int $contentElementUid)
    {
        $formDefinition->createFinisher('Confirmation', [
            'contentElementUid' => $contentElementUid,
        ]);
    }
}

This finisher is implemented in \TYPO3\CMS\Form\Domain\Finishers\ConfirmationFinisher.