Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
.. include:: /Includes.rst.txt
.. index:: Events; AfterFormIsBuiltEvent

.. _AfterFormIsBuiltEvent:

=====================
AfterFormIsBuiltEvent
=====================

.. versionadded:: 14.0
The events :php-short:`TYPO3\CMS\Form\Event\AfterFormIsBuiltEvent`
and :php-short:`TYPO3\CMS\Form\Event\BeforeRenderableIsAddedToFormEvent`
provide an improved replacement for the removed hook
:php:`$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/form']['afterBuildingFinished']`.

The event :php-short:`TYPO3\CMS\Form\Event\AfterFormIsBuiltEvent`
allows the form definition to be modified after a form has been created.


.. _AfterFormIsBuiltEvent-example:

Example
=======

.. literalinclude:: _AfterFormIsBuiltEvent/_MyEventListener.php
:caption: EXT:my_extension/Classes/EventListener/MyEventListener.php

.. _AfterFormIsBuiltEvent-api:

API
===

.. include:: /CodeSnippets/Events/Form/AfterFormIsBuiltEvent.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?php

declare(strict_types=1);

namespace MyVendor\MyExtension\EventListener;

use TYPO3\CMS\Core\Attribute\AsEventListener;
use TYPO3\CMS\Form\Event\AfterFormIsBuiltEvent;

final readonly class MyEventListener
{
#[AsEventListener(
identifier: 'my-extension/after-form-is-built',
)]
public function __invoke(AfterFormIsBuiltEvent $event): void
{
$event->form->setLabel('foo');
}
}
6 changes: 6 additions & 0 deletions Documentation/CodeSnippets/Config/Api/Events/EventsForm.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
<?php

return [
[
'action' => 'createPhpClassDocs',
'class' => \TYPO3\CMS\Form\Event\AfterFormIsBuiltEvent::class,
'targetFileName' => 'CodeSnippets/Events/Form/AfterFormIsBuiltEvent.rst.txt',
'withCode' => false,
],
[
'action' => 'createPhpClassDocs',
'class' => \TYPO3\CMS\Form\Mvc\Persistence\Event\AfterFormDefinitionLoadedEvent::class,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets
.. php:namespace:: TYPO3\CMS\Form\Event

.. php:class:: AfterFormIsBuiltEvent

Listeners to this event will be able to modify the form definition
after a form is created.

.. php:attr:: form
:public: