Actions

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

From Joomla! Documentation

(Updated contents)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
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.
+
{{version|2.5,3.x}}
 +
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  code:
 
 
<source lang="php">
 
<source lang="php">
$dispatcher =& JDispatcher::getInstance();
+
$text = JHtml::_('content.prepare', $text);
$results = $dispatcher->trigger('onSomething', $params);
+
 
</source>
 
</source>
This function calls every plugin that has registered itself for the event <code>'onSomething'</code> and hands over the array <code>$param</code> 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:
  
You can also pass arguments by reference to allow plugins to edit the passed data. For example:
 
 
<source lang="php">
 
<source lang="php">
$dispatcher =& JDispatcher::getInstance();
+
// Note JDispatcher is deprecated in favour of JEventDispatcher in Joomla 3.x however still works.
$dispatcher->trigger('onSomething', &$params);
+
$dispatcher = JDispatcher::getInstance();
 +
$item->text = your_text_area_item; 
 +
$item->params = clone($params);
 +
JPluginHelper::importPlugin('content');  
 +
$dispatcher->trigger('onPrepareContent', array (& $item, & $item->params, 0));  
 
</source>
 
</source>
  
A common usage might be 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 latest release of Joomla! 1.5 {{JVer|1.5}} and newer versions, you can simply use:
+
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.
 
+
<source lang="php">
+
        $text = JHTML::_('content.prepare', $text);
+
</source>
+
 
+
For early versions of Joomla! 1.5, you need to "spell it out":
+
 
+
<source lang="php">
+
        $dispatcher =& JDispatcher::getInstance();
+
        $item->text = & your_text_area_item; 
+
        $item->params = clone($params);
+
        JPluginHelper::importPlugin('content');
+
        $dispatcher->trigger('onPrepareContent', array (& $item, & $item->params, 0));
+
</source>
+
 
+
You might want to look at core components (for example com_content) for an example.
+
  
 
Also for PHP5.3 compliance please look at the discussion page.
 
Also for PHP5.3 compliance please look at the discussion page.
<noinclude>[[Category:Extension development]][[Category:Plugins]]</noinclude>
+
<noinclude>[[Category:Extension development]][[Category:Plugins]]
 +
[[Category:Plugin Development]]
 +
[[Category:Development Recommended Reading]]
 +
</noinclude>

Latest revision as of 15:56, 8 October 2013

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:

// Note JDispatcher is deprecated in favour of JEventDispatcher in Joomla 3.x however still works.
$dispatcher = JDispatcher::getInstance();
$item->text = your_text_area_item;  
$item->params = clone($params);
JPluginHelper::importPlugin('content'); 
$dispatcher->trigger('onPrepareContent', array (& $item, & $item->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.