Actions

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

From Joomla! Documentation

m (Tutorial:Using plugins in your own extension moved to Using plugins in your own extension: Moved page to main namespace because the Tutorial namespace is deprecated)
(Updated contents)
Line 1: Line 1:
[[Category:Development]]
 
[[Category:Plugins]]
 
 
 
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.
 
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.
  
Line 9: Line 6:
 
$results = $dispatcher->trigger('onSomething', $params);
 
$results = $dispatcher->trigger('onSomething', $params);
 
</source>
 
</source>
This function calls everyplugin that has registered itself for the event 'onSomething' and hands over the array $param as parameter.  
+
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.
 
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.
Line 19: Line 16:
 
</source>
 
</source>
  
A common usage might be to use the content plugins if you have an editable field. This is the code that will do that:
+
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:
 +
 
 +
<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">
 
<source lang="php">
Line 32: Line 35:
  
 
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>

Revision as of 16:22, 11 February 2012

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.

To activate the plugins for your addon, you just have to use the following code:

$dispatcher =& JDispatcher::getInstance();
$results = $dispatcher->trigger('onSomething', $params);

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.

You can also pass arguments by reference to allow plugins to edit the passed data. For example:

$dispatcher =& JDispatcher::getInstance();
$dispatcher->trigger('onSomething', &$params);

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 Joomla 1.5 and newer versions, you can simply use:

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

For early versions of Joomla! 1.5, you need to "spell it out":

        $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.

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