API15

Difference between revisions of "JFactory/getEditor"

From Joomla! Documentation

< API15: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 50: Line 50:
  
 
<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 65: Line 65:
 
  format= ,,,
 
  format= ,,,
 
</dpl>
 
</dpl>
 +
[[Category:Archived pages API15]]

Revision as of 11:51, 12 May 2013

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[edit]

Get an editor object

[<! removed edit link to red link >]

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

Syntax[edit]

& 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]

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[edit]

<CodeExamplesForm />