JFactory/getEditor

The "API16" 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[edit]

Get an editor object

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

Syntax[edit]

static getEditor($editor=null)

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

Returns[edit]

object

Defined in[edit]

libraries/joomla/factory.php

Importing[edit]

jimport( 'joomla.factory' );

Source Body[edit]

public static 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');
        }

        return JEditor::getInstance($editor);
}

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

Examples[edit]

Code Examples[edit]

API16