The textarea form field type provides a text area for entry of multi-line text.

Example XML field definition:

<field name="mytextarea" 
type="textarea"
default="default"
label="Enter some text"
description=""
rows="10" cols="5" />

Use the raw filter to ensure that html code is preserved when the form is processed.

<field name="mytextarea" 
type="textarea"
default="default"

label="Enter some html"
description=""
rows="10" cols="5"
filter="raw"/>

Parameters

Mandatory Parameters

  • type (mandatory) must be textarea.
  • name (mandatory) is the unique name of the field.
  • label (mandatory) (translatable) is the descriptive title of the field.
  • rows (mandatory) is the height of the visible text area in lines.
  • cols (mandatory) is the width of the visible text area in characters.

Optional Parameters

  • default (optional) (not translatable) is the default value.
  • description (optional) (translatable) is text that will be shown as a tooltip.
  • class (optional) is a CSS class name for the HTML form field. If omitted this will default to 'text_area'.
  • filter (optional) allow the system to save certain html tags or raw data.
  • hint (optional) The text displayed in the html placeholder element, usually a lighter coloured hint displayed inside an blank field.
Star InactiveStar InactiveStar InactiveStar InactiveStar Inactive