form¶

Form ViewHelper. Generates a <form> Tag.

Basic usage¶

Use <f:form> to output an HTML <form> tag which is targeted at the specified action, in the current controller and package. It will submit the form data via a POST request. If you want to change this, use method="get" as an argument.

Examples¶

A complex form with a specified encoding type¶

Form with enctype set:

<f:form action=".." controller="..." package="..." enctype="multipart/form-data">...</f:form>

A Form which should render a domain object¶

Binding a domain object to a form:

<f:form action="..." name="customer" object="{customer}">
   <f:form.hidden property="id" />
   <f:form.textbox property="name" />
</f:form>

This automatically inserts the value of {customer.name} inside the textbox and adjusts the name of the textbox accordingly.

Arguments¶

additionalAttributes¶

DataType: mixed
Required: false
Description: Additional tag attributes. They will be added directly to the resulting HTML tag.

data¶

DataType: mixed
Required: false
Description: Additional data-* attributes. They will each be added with a "data-" prefix.

aria¶

DataType: mixed
Required: false
Description: Additional aria-* attributes. They will each be added with a "aria-" prefix.

action¶

DataType: string
Required: false
Description: Target action

arguments¶

DataType: mixed
Default: array ()
Required: false
Description: Arguments

controller¶

DataType: string
Required: false
Description: Target controller

extensionName¶

DataType: string
Required: false
Description: Target Extension Name (without tx_ prefix and no underscores). If NULL the current extension name is used

pluginName¶

DataType: string
Required: false
Description: Target plugin. If empty, the current plugin name is used

pageUid¶

DataType: mixed
Required: false
Description: Target page uid

object¶

DataType: mixed
Required: false
Description: Object to use for the form. Use in conjunction with the "property" attribute on the sub tags

pageType¶

DataType: mixed
Required: false
Description: Target page type

noCache¶

DataType: mixed
Required: false
Description: Set this to disable caching for the target page. You should not need this.

section¶

DataType: string
Required: false
Description: The anchor to be added to the action URI (only active if $actionUri is not set)

format¶

DataType: string
Required: false
Description: The requested format (e.g. ".html") of the target page (only active if $actionUri is not set)

additionalParams¶

DataType: mixed
Default: array ()
Required: false
Description: Additional action URI query parameters that won't be prefixed like $arguments (overrule $arguments) (only active if $actionUri is not set)

absolute¶

DataType: mixed
Required: false
Description: If set, an absolute action URI is rendered (only active if $actionUri is not set)

addQueryString¶

DataType: mixed
Required: false
Description: If set, the current query parameters will be kept in the action URI (only active if $actionUri is not set)

argumentsToBeExcludedFromQueryString¶

DataType: mixed
Default: array ()
Required: false
Description: Arguments to be removed from the action URI. Only active if $addQueryString = TRUE and $actionUri is not set

addQueryStringMethod¶

DataType: string
Required: false
Description: This argument is not evaluated anymore and will be removed in TYPO3 v12.

fieldNamePrefix¶

DataType: string
Required: false
Description: Prefix that will be added to all field names within this form. If not set the prefix will be tx_yourExtension_plugin

actionUri¶

DataType: string
Required: false
Description: Can be used to overwrite the "action" attribute of the form tag

objectName¶

DataType: string
Required: false
Description: Name of the object that is bound to this form. If this argument is not specified, the name attribute of this form is used to determine the FormObjectName

hiddenFieldClassName¶

DataType: string
Required: false
Description: HiddenFieldClassName

enctype¶

DataType: string
Required: false
Description: MIME type with which the form is submitted

method¶

DataType: string
Required: false
Description: Transfer type (GET or POST)

name¶

DataType: string
Required: false
Description: Name of form

onreset¶

DataType: string
Required: false
Description: JavaScript: On reset of the form

onsubmit¶

DataType: string
Required: false
Description: JavaScript: On submit of the form

target¶

DataType: string
Required: false
Description: Target attribute of the form

novalidate¶

DataType: mixed
Required: false
Description: Indicate that the form is not to be validated on submit.

class¶

DataType: string
Required: false
Description: CSS class(es) for this element

dir¶

DataType: string
Required: false
Description: Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left)

id¶

DataType: string
Required: false
Description: Unique (in this file) identifier for this HTML element.

lang¶

DataType: string
Required: false
Description: Language for this element. Use short names specified in RFC 1766

style¶

DataType: string
Required: false
Description: Individual CSS styles for this element

title¶

DataType: string
Required: false
Description: Tooltip text of element

accesskey¶

DataType: string
Required: false
Description: Keyboard shortcut to access this element

tabindex¶

DataType: integer
Required: false
Description: Specifies the tab order of this element

onclick¶

DataType: string
Required: false
Description: JavaScript evaluated for the onclick event