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 back-end in the plugins section.

XML Definition

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

Mandatory Parameters

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

Optional Parameters

  • width defines the width (in pixels) of the wysiwyg editor and defaults to 100%.
  • height defines the height (in pixels) of the wysiwyg editor and defaults to 250px.
  • cols defines the width of the editor (in columns).
  • rows defines the height of the editor (in rows).
  • buttons can be an array of plugin buttons to be excluded or set to false.
  • hide 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 allow the system to save certain html tags or raw data.

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"
/>

 

Star InactiveStar InactiveStar InactiveStar InactiveStar Inactive