Actions

API15

JFactory/getEditor

From Joomla! Documentation

< API15:JFactory
Revision as of 11:51, 12 May 2013 by JoomlaWikiBot (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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

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

Examples

<CodeExamplesForm />