Plugin/Events/Module

In a standard installation of Joomla! we have several predefined Module events which, when triggered, call functions in the associated plugins.

onRenderModule

Description

This is an event that is called when a module on the front- or back-end is rendered.

Parameters

• &module A reference to a Module object that holds all the data of the module
• &attribs An array of attributes for the module

Return Value

None. Result will be omitted.

onAfterRenderModule

Description

This is an event that is called when after a module is rendered on the back- or front-end

Parameters

• &module A reference to a Module object that holds all the data of the module
• &attribs An array of attributes for the module

Return Value

None. Result will be omitted.

onPrepareModuleList

Description

This is an event that is called before the list of modules that must be rendered is created. If the &modules parameter is an array of module objects, the default module list generated by Joomla! is ignored.

Parameters

• &modules Reference to a empty variable for the list of modules

Return Value

None. Result will be omitted.

onAfterModuleList

Description

This is an even that is called after the list of modules that must be rendered is created.

Parameters

• &modules Reference to an array of module objects

Return Value

None. Result will be omitted.

onAfterCleanModuleList

Description

This is an event that is called after the module list is cleaned.

Parameters

• &modules A reference to an array of rendered module objects

Return Value

None. Result will be omitted.