Difference between revisions of "Plugin/Events/Quickicon"
From Joomla! Documentation
< Plugin | Events
Phproberto (talk | contribs) |
Phproberto (talk | contribs) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
Events of Quickicon | Events of Quickicon | ||
| Line 16: | Line 14: | ||
'''Example''': | '''Example''': | ||
<source lang="php"> | <source lang="php"> | ||
| − | return array( | + | $return = array( |
array( | array( | ||
'link' => 'index.php?option=com_joomlaupdate', | 'link' => 'index.php?option=com_joomlaupdate', | ||
| Line 29: | Line 27: | ||
=== Called in files === | === Called in files === | ||
| − | + | * <code>administrator/modules/mod_quickicon/helper.php</code> | |
<noinclude>[[Category:Plugin Development]][[Category:Specifications]]</noinclude> | <noinclude>[[Category:Plugin Development]][[Category:Specifications]]</noinclude> | ||
Latest revision as of 12:20, 15 July 2014
Events of Quickicon
onGetIcons[edit]
Description[edit]
This method is called when the Quick Icons module is constructing its set of icons. You can return an array which defines a single icon and it will be rendered right after the stock Quick Icons.
Parameters[edit]
contextThe context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article). Use this to check whether you are in the desired context for the plugin.
Return Value[edit]
A list of icon definition associative arrays, consisting of the keys link, image, text and access.
Example:
$return = array(
array(
'link' => 'index.php?option=com_joomlaupdate',
'image' => 'joomla',
'icon' => 'header/icon-48-download.png',
'text' => JText::_('PLG_QUICKICON_JOOMLAUPDATE_CHECKING'),
'id' => 'plg_quickicon_joomlaupdate',
'group' => 'MOD_QUICKICON_MAINTENANCE'
)
);Called in files[edit]
administrator/modules/mod_quickicon/helper.php