Editors form field type

From Joomla! Documentation

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
Other languages:
English • ‎Nederlands • ‎español • ‎français

The editors form field type provides a drop down list of the available and enabled WYSIWYG editors. If the field has a saved value this is selected when the page is first loaded. If not, the default value (if any) is selected.

Params.editors.jpg

The first option on the list is always '- Select Editor -' (which is a translatable string) and is given the value 0.

  • type (mandatory) must be editors.
  • name (mandatory) is the unique name of the parameter.
  • label (mandatory) (translatable) is the descriptive title of the field.
  • default (optional) is the default editor name. This is the name listed in the File column in the Plugin Manager screen.
  • description (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.

Example XML parameter definition:

<field name="myeditor" type="editors" default="none" label="Select an editor" />

See also