Module Plant

Joomla! system plugin that shows any Joomla! module in any content. With this plugin you can override some module parameters or create virtual instance of a module which does not require saving module parameters in a database.

Features

• Loads Joomla! modules into any content
• Module parameters overriding
• Creates a virtual instance of a Joomla! module
• Easy to use, only enter a module id

Requirements

Plugin works on Joomla! 1.5 - 3.0.

Installation & Usage

Read this article on official Joomla! Help Site to learn how to install/uninstall Joomla! extensions.

Quick start

---

1. Before using the plugin, check that it is enabled. Open Extensions -> Plugin Manager page and check Status field.

2. Open Extensions -> Module Manager page, choose module that you want to load and remember its module id.

3. Open the article or other content item where you want to load a module and enter the next code:

    [moduleplant id="<module_id>"]
    

replace <module_id> with necessary module ID.

The plugin supports ability to change some parameters directly in [moduleplant] tag. If some parameters are omitted, a default value will be used for them. Default values are set on plugin settings page. See the list of supported parameters below:

• mod_showtitle is used to show/hide the title of the loaded module. If the parameter is 1, the title will be shown. If it is 0, the title will be hidden. If the value of the parameter is empty, will be used value of "Show title" parameter from the loaded module.
• style is used to set module chrome style. Possible values are none, horz, table, xhtml, rounded.

The code below wraps a module output with nested DIVs and hide module title:

    [moduleplant id="99" style="rounded" mod_showtitle="0"]
    

Advanced usage

---

1. If you want to create a virtual instance of a module which will not store its state in a database and will be created on the fly, enter the next code:

    [moduleplant module="<module_type>"]
    

replace <module_type> with the necessary module type.

2. This plugin supports module parameters overriding. Use the next code for overriding parameters:

    [moduleplant id="77" <param_name_1>="<param_value_1>"  <param_name_N>="<param_value_N>"]
    

replace <param_name_N> and <param_value_N> with the necessary parameter name and value. You can override as many parameters as you want. Available module parameters can be found in module XML manifest file. A manifest file is usually located in the next path:

    modules/<module_type>/<module_type>.xml
    

Code examples

---

1. How to display module with ID = 56 in Joomla! content with the help of "Module Plant" plugin?

Enter the next code into a Joomla! content:

    [moduleplant id="56"]
    

2. I want to create a virtual instance of "mod_latestnews" module (or any other module) and set some module parameters. How can I do it?

Enter the next code. It shows three latest pieces of news from content category with ID = 17.

    [moduleplant module="mod_latestnews" count="3" catid="17"]