Actions

API16

Difference between revisions of "JFactory/getEditor"

From Joomla! Documentation

< API16:JFactory
(New page: ===Description=== Get an editor object <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>Edit Descripton<nowiki>]</nowiki> </span...)
 
m (removing red link to edit, no existant pages)
 
Line 3: Line 3:
  
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[Description:JFactory/getEditor|Edit Descripton]]<nowiki>]</nowiki>
+
<nowiki>[<! removed edit link to red link >]</nowiki>
 
</span>
 
</span>
  
{{Description:JFactory/getEditor}}
+
<! removed transcluded page call, red link never existed >
  
 
===Syntax===
 
===Syntax===
Line 48: Line 48:
  
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[SeeAlso:JFactory/getEditor|Edit See Also]]<nowiki>]</nowiki>
+
<nowiki>[<! removed edit link to red link >]</nowiki>
 
</span>
 
</span>
{{SeeAlso:JFactory/getEditor}}
+
<! removed transcluded page call, red link never existed >
  
 
===Examples===
 
===Examples===
Line 63: Line 63:
 
  format= ,,,
 
  format= ,,,
 
</dpl>
 
</dpl>
 +
[[Category:Archived pages API16]]

Latest revision as of 00:06, 13 May 2013

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 />