Actions

API16

JFactory/getEditor

From Joomla! Documentation

< API16:JFactory
Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Contents

Description

Get an editor object

[<! removed edit link to red link >]

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

Syntax

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

object

Defined in

libraries/joomla/factory.php

Importing

jimport( 'joomla.factory' );

Source Body

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 edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />