View Helpers Error Functions string controller
Returns the error message, if one exists, on the object's property. If multiple error messages exist, the first one is returned.
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| objectName | string | Yes | The variable name of the object to display the error message for. | |
| property | string | Yes | The name of the property to display the error message for. | |
| prependText | string | No | String to prepend to the error message. | |
| appendText | string | No | String to append to the error message. | |
| wrapperElement | string | No | span | HTML element to wrap the error message in. |
| class | string | No | error-message | CSS class to set on the wrapper element. |
| encode | boolean | 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. |