Actions

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

From Joomla! Documentation

(adding working code)
Line 6: Line 6:
 
To activate the plugins for your addon, you just have to use the following  code:
 
To activate the plugins for your addon, you just have to use the following  code:
 
<source lang="php">
 
<source lang="php">
 +
$dispatcher =& JDispatcher::getInstance();
 
$results = $dispatcher->trigger('onSomething', $params);
 
$results = $dispatcher->trigger('onSomething', $params);
 
</source>
 
</source>
Line 12: Line 13:
 
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.
  
For this actually to work you will need a bit more.
+
You can also pass arguments by reference to allow plugins to edit the passed data. For example:
 +
<source lang="php">
 +
$dispatcher =& JDispatcher::getInstance();
 +
$dispatcher->trigger('onSomething', &$params);
 +
</source>
  
You might want to look at com_content for an example ...
+
You might want to look at core components (for example com_content) for an example.

Revision as of 09:57, 14 January 2009


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);

You might want to look at core components (for example com_content) for an example.