Joomla! Documentation™

The "API15" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Description

Get an editor object

<! removed transcluded page call, red link never existed >

Syntax

& getEditor($editor=null)

Parameter Name	Default Value	Description
$editor	null	$editor The editor to load, depends on the editor plugins that are installed

Returns

object

Defined in

libraries/joomla/factory.php

Importing

jimport( 'joomla.factory' );

Source Body

function &getEditor($editor = null)
{
        jimport( 'joomla.html.editor' );

        //get the editor configuration setting
        if(is_null($editor))
        {
                $conf =& JFactory::getConfig();
                $editor = $conf->getValue('config.editor');
        }

        $instance =& JEditor::getInstance($editor);

        return $instance;
}

<! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />