J3.x

Triggering content plugins in your extension: Difference between revisions

From Joomla! Documentation

Wilsonge (talk | contribs)
Updates to be 3.x specific
translation strings fixed
Line 15: Line 15:
$article->text = $text;
$article->text = $text;


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


// Note JEventDispatcher succeeded the older JDispatcher from Joomla 1.5/2.5 however it does still work if you need to keep compatibility.
// <translate>Note JEventDispatcher succeeded the older JDispatcher from Joomla 1.5/2.5 however it does still work if you need to keep compatibility.</translate>
JPluginHelper::importPlugin('content');
JPluginHelper::importPlugin('content');
$dispatcher = JEventDispatcher::getInstance();
$dispatcher = JEventDispatcher::getInstance();
Line 28: Line 28:


<noinclude>
<noinclude>
<translate>
[[Category:Extension development{{#translation:}}]]
<!--T:6-->
[[Category:Plugins{{#translation:}}]]
[[Category:Extension development]]
[[Category:Plugin Development{{#translation:}}]]
[[Category:Plugins]]
[[Category:Development Recommended Reading{{#translation:}}]]
[[Category:Plugin Development]]
[[Category:Development Recommended Reading]]
</translate>
</noinclude>
</noinclude>

Revision as of 17:24, 7 April 2020

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 JEventDispatcher succeeded the older JDispatcher from Joomla 1.5/2.5 however it does still work if you need to keep compatibility.
JPluginHelper::importPlugin('content');
$dispatcher = JEventDispatcher::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.