View Helpers Form Tag Functions string controller
Builds and returns a string containing a text field form control based on the supplied name.
Note: Pass any additional arguments like class, rel, and id, and the generated tag will also include those values as HTML attributes.
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| name | string | Yes | Name to populate in tag's name attribute. | |
| value | string | No | Value to populate in tag's value attribute. | |
| label | string | No | The label text to use in the form control. | |
| labelPlacement | string | No | around | Whether to place the label before, after, or wrapped around the form control. Label text placement can be controlled using aroundLeft or aroundRight. |
| prepend | string | No | String to prepend to the form control. Useful to wrap the form control with HTML tags. | |
| append | string | No | String to append to the form control. Useful to wrap the form control with HTML tags. | |
| prependToLabel | string | No | String to prepend to the form control's label. Useful to wrap the form control with HTML tags. | |
| appendToLabel | string | No | String to append to the form control's label. Useful to wrap the form control with HTML tags. | |
| type | string | No | text | Input type attribute. Common examples in HTML5 and later are text (default), email, tel, and url. |
| encode | any | No | true | Use this argument to decide whether the output of the function should be encoded in order to prevent Cross Site Scripting (XSS) attacks. Set it to true to encode all relevant output for the specific HTML element in question (e.g. tag content, attribute values, and URLs). For HTML elements that have both tag content and attribute values you can set this argument to attributes to only encode attribute values and not tag content. |
<!--- Basic usage usually involves a `label`, `name`, and `value` --->
#textFieldTag(label="Search", name="q", value=params.q)#