Actions

Difference between revisions of "JDocument/addScript"

From Joomla! Documentation

m (Example depends on document type.)
m (& is not needed)
 
(2 intermediate revisions by one user not shown)
Line 23: Line 23:
 
To add a link to some JavaScript code at a specific URL, you could use:
 
To add a link to some JavaScript code at a specific URL, you could use:
 
<source lang="php">
 
<source lang="php">
$doc =& JFactory::getDocument();
+
$doc = JFactory::getDocument();
 
$doc->addScript("http://www.example.com/js/myscript.js");
 
$doc->addScript("http://www.example.com/js/myscript.js");
 
</source>
 
</source>
Line 32: Line 32:
  
 
===See also===
 
===See also===
* [http://api.joomla.org/Joomla-Framework/Document/JDocument.html#addScript JDocument->addScript on api.joomla.org]
+
* [http://api.joomla.org/cms-3/classes/JDocument.html#method_addScript JDocument->addScript on api.joomla.org]
 
* [[JDocument/addScriptDeclaration|JDocument->addScriptDeclaration]]
 
* [[JDocument/addScriptDeclaration|JDocument->addScriptDeclaration]]
 
<noinclude>[[Category:Development]][[Category:Framework]][[Category:JDocument]]</noinclude>
 
<noinclude>[[Category:Development]][[Category:Framework]][[Category:JDocument]]</noinclude>

Latest revision as of 08:27, 18 August 2014

Adds the definition of a linked external script to the document object. Duplicates are ignored.

Syntax

void addScript( $url, $type )

where:

Argument Data type Description Default
$url string URL of script.
$type string MIME type of script. 'text/javascript'

Example

To add a link to some JavaScript code at a specific URL, you could use:

$doc = JFactory::getDocument();
$doc->addScript("http://www.example.com/js/myscript.js");

How this is rendered depends on the document type. If the document type is HTML then this code will produce following link in the HTML HEAD section:

<script type="text/javascript" src="http://www.example.com/js/myscript.js"></script>

See also