Actions

JFactory/getEditor

From Joomla! Documentation

Revision as of 14:50, 23 November 2008 by Chris Davenport (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Returns a reference to the global editor object, only creating it if it doesn't already exist. The object returned will be of type JEditor.

Syntax

object JEditor getEditor( $editor )

where:

Argument Data type Description Default
$editor string The name of the editor (for example, 'tinymce'). If null then the current editor will be returned. null

Example

In this example, the current editor is returned. TODO: Need a better example.

$editor =& JFactory::getEditor();

See also