The editor field type provides a WYSIWYG (What You See Is What You Get) editor. You can change the editor configuration and access level display options at the back-end in the plugins section.

Example XML Definition:

<field name="test1" 
type="editor"
label="Test Field"
description=""
width="300"
filter="safehtml" />

Parameters

Mandatory Parameters

  • type (mandatory) must be editor.
  • name (mandatory) is the unique name of the parameter.
  • label (mandatory) (translatable) is the descriptive title of the field.

Optional Parameters

  • width (optional) defines the width (in pixels) of the wysiwyg editor and defaults to 100%.
  • height (optional) defines the height (in pixels) of the wysiwyg editor and defaults to 250px.
  • cols (optional) defines the width of the editor (in columns).
  • rows (optional) defines the height of the editor (in rows).
  • buttons (optional) can be an array of plugin buttons to be excluded or set to false.
  • hide (optional) array of plugin buttons to be hidden. eg... set buttons="true" hide="readmore,pagebreak"
  • editor specifies the editor to be used and can include two options (editor="desired|alternative")
  • filter (optional) allow the system to save certain html tags or raw data.