Joomla editor Form Field Type

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 backend in the plugins section. The editor field extends Textarea Field.

XML Definition

<field name="description" 
 type="editor" 
 label="Description"
 filter="safehtml" />

Additional Parameters

width: It defines the width (in pixels) of the wysiwyg editor and defaults to 100%.

height: It defines the height (in pixels) of the wysiwyg editor and defaults to 250px.

buttons: It defines to show or hide editor buttons. You set this to true or false.

hide: This is the array of plugin buttons to be hidden. For example, set buttons="true" hide="readmore,pagebreak"

editor: It specifies the editor to be used.

Examples

1. Article Text Field (com_content)

<field
 name="articletext"
 type="editor"
 label="COM_CONTENT_FIELD_ARTICLETEXT_LABEL"
 description="COM_CONTENT_FIELD_ARTICLETEXT_DESC"
 filter="JComponentHelper::filterText"
 buttons="true" />

2. Category Description Field (com_categories)

<field
 name="description"
 type="editor"
 label="JGLOBAL_DESCRIPTION"
 description="COM_CATEGORIES_DESCRIPTION_DESC"
 filter="JComponentHelper::filterText"
 buttons="true"
 hide="readmore,pagebreak" />

3. Miscellaneous Information Field (com_contact)

<field
 name="misc"
 type="editor"
 label="COM_CONTACT_FIELD_INFORMATION_MISC_LABEL"
 description="COM_CONTACT_FIELD_INFORMATION_MISC_DESC"
 filter="JComponentHelper::filterText"
 buttons="true"
 hide="readmore,pagebreak" />