J3.x

Difference between revisions of "Triggering content plugins in your extension"

From Joomla! Documentation

(Importing text file)
(19 intermediate revisions by 9 users not shown)
Line 1: Line 1:
−
====5.5 Using plugins in your own addon====
+
{{version|2.5,3.x}}
−
Using the plugin system in your addon is fairly simple. The most important part is good planning because, to some degree, you're defining an interface for other people to use.
+
A common example of [[Supporting plugins in your component|using plugins]] is to run the '''content plugins''' on some text. This is useful if you want to support plugins that usually work on Content from a custom extension. For the content prepare trigger you can simply call:
  
−
To activate the plugins for your addon, you just have to use the following line of code:
 
 
<source lang="php">
 
<source lang="php">
−
$result = $mainframe->triggerEvent( 'onSomething', $param );
+
$text = JHtml::_('content.prepare', $text);
 
</source>
 
</source>
−
This function calls every plugin that has registered itself for the event 'onSomething' and hands over the array $param as parameter.
 
  
−
As a return value you get an array of results from these plugins. All this is of course optional, you could also use the system without parameters and/or a result.
+
For any other content triggers you must call:
 +
 
 +
<source lang="php">
 +
$article = new stdClass;
 +
$article->text = $text;
 +
 
 +
// add more to parameters if needed
 +
$params = new JObject;
 +
 
 +
// Note JDispatcher is deprecated in favour of JEventDispatcher in Joomla 3.x however still works.
 +
JPluginHelper::importPlugin('content');
 +
$dispatcher = JDispatcher::getInstance();
 +
$dispatcher->trigger('onContentPrepare', array('some.context', &$article, &$params, 0));
 +
</source>
 +
 
 +
You might want to look at core components (for example com_content) for an example. See the [[Plugin/Events|triggers page]] for the possible content plugin triggers.
 +
 
 +
Also for PHP5.3 compliance please look at the discussion page.
 +
<noinclude>[[Category:Extension development]][[Category:Plugins]]
 +
[[Category:Plugin Development]]
 +
[[Category:Development Recommended Reading]]
 +
</noinclude>

Revision as of 12:13, 27 March 2015

This article is for Joomla! CMS Version(s) Joomla 2.5 Joomla 3.x

A common example of using plugins is to run the content plugins on some text. This is useful if you want to support plugins that usually work on Content from a custom extension. For the content prepare trigger you can simply call: 

$text = JHtml::_('content.prepare', $text);

For any other content triggers you must call: 

$article = new stdClass;
$article->text = $text;

// add more to parameters if needed
$params = new JObject;

// Note JDispatcher is deprecated in favour of JEventDispatcher in Joomla 3.x however still works.
JPluginHelper::importPlugin('content');
$dispatcher = JDispatcher::getInstance();
$dispatcher->trigger('onContentPrepare', array('some.context', &$article, &$params, 0));

You might want to look at core components (for example com_content) for an example. See the triggers page for the possible content plugin triggers.

Also for PHP5.3 compliance please look at the discussion page.

Retrieved from "https://docs.joomla.org/index.php?title=J3.x:Triggering_content_plugins_in_your_extension&oldid=166813"