Triggering content plugins in your extension - Revision history

Mvangeest: Merged into Supporting plugins in your component

2012-07-05T18:43:40Z

Merged into Supporting plugins in your component

Mvangeest: moved Using plugins in your own extension to Triggering content plugins in your extension: Merged into Supporting plugins in your component - redistributed content

2012-07-05T18:40:51Z

moved Using plugins in your own extension to Triggering content plugins in your extension: Merged into Supporting plugins in your component - redistributed content

Mvangeest: Updated contents

2012-02-11T21:22:58Z

Updated contents

Mvangeest: 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

2011-01-15T15:44:23Z

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

Petergeier at 17:30, 15 July 2010

2010-07-15T17:30:20Z

Petergeier at 17:29, 15 July 2010

2010-07-15T17:29:52Z

Kittymcooper: added the exact code to use content plugins

2010-03-10T05:27:50Z

added the exact code to use content plugins

Pentacle at 15:57, 14 January 2009

2009-01-14T15:57:53Z

Yisraeldov: adding working code

2008-11-11T14:01:07Z

adding working code

Yisraeldov at 13:57, 11 November 2008

2008-11-11T13:57:03Z

@@ 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.
+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 latest release of Joomla! 1.5 {{JVer|1.5}} and newer versions, you can simply use:
 <source lang="php">
-$dispatcher =& JDispatcher::getInstance();
+$text = JHTML::_('content.prepare', $text);
-$results = $dispatcher->trigger('onSomething', $params);
 </source>
-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 early versions of Joomla! 1.5, you need to "spell it out":
 <source lang="php">
 $dispatcher =& JDispatcher::getInstance();
-$dispatcher->trigger('onSomething', &$params);
+$item->text = & your_text_area_item;
-</source>
+$item->params = clone($params);
 JPluginHelper::importPlugin('content');
-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:
+$dispatcher->trigger('onPrepareContent', array (& $item, & $item->params, 0));
-−
-<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>

@@ 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.
@@ Line 9: / Line 6: @@
 $results = $dispatcher->trigger('onSomething', $params);
 </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.
@@ Line 19: / Line 16: @@
 </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">
@@ Line 32: / Line 35: @@
 Also for PHP5.3 compliance please look at the discussion page.

← Older revision		Revision as of 17:30, 15 July 2010
Line 30:		Line 30:

	You might want to look at core components (for example com_content) for an example.		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.

← Older revision		Revision as of 17:29, 15 July 2010
Line 30:		Line 30:

	You might want to look at core components (for example com_content) for an example.		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.

@@ Line 9: / Line 9: @@
 $results = $dispatcher->trigger('onSomething', $params);
 </source>
-This function calls every plugin that has registered itself for the event 'onSomething' and hands over the array $param as parameter.
+This function calls everyplugin 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.
@@ Line 17: / Line 17: @@
 $dispatcher =& JDispatcher::getInstance();
 $dispatcher->trigger('onSomething', &$params);
 </source>
 You might want to look at core components (for example com_content) for an example.

@@ Line 6: / Line 6: @@
 To activate the plugins for your addon, you just have to use the following  code:
 <source lang="php">
 $results = $dispatcher->trigger('onSomething', $params);
 </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.
-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:
-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.