Get Started

Module Parameters Export/Import is a powerful Joomla system plugin that adds Export and Import functionality to module parameters. This plugin allows you to export module settings to a JSON file and import them back into any module, making it easy to copy module configurations across your site or backup settings for migration.

Key Features:

• Export module parameters to JSON with one click
• Import parameters from JSON files with confirmation modal
• Universal compatibility with all Joomla modules (core and third-party)
• Full support for subform/repeatable fields
• Proper handling of TinyMCE and editor fields
• Backend database integration for reliable data operations
• Professional confirmation modal with parameter count
• Joomla 4, 5 & 6 compatible

Perfect for webmasters who need to copy module configurations, backup settings, or migrate module data between sites.

Downloading the Plugin

After you purchase the extension from our store, you will receive an email containing a link to download the plugin file: plg_system_modexport.zip

Alternatively, you can download the extension from the "Downloads" section in our store.

Installing the Plugin

To install the plugin, log in to the backend of your Joomla website.

• For Joomla 4, 5 & 6: Navigate to System > Install > Extensions. You can either drag and drop or browse for the file to install.

A success message will be displayed once the installation is complete.

After Installation

The plugin needs to be enabled after installation:

• Go to Extensions > Plugins
• Search for Module Parameters Export/Import
• Click on the plugin name and click Enabled toggle, then Save & Close
• The Export/Import tab will now appear in all module edit pages

Exporting Module Parameters

Exporting module parameters is simple and straightforward:

1. Navigate to Content > Site Modules (or System > Administrator Modules for admin modules)
2. Click on the module you want to export
3. Click on the Export/Import tab in the module edit form
4. Click the Export Parameters button
5. A JSON file will be downloaded automatically with the filename: module_[module_name]_parameters.json

What Gets Exported?

• All module parameters from the params fieldset
• Subform/repeatable fields with all rows and nested data
• Editor field content (TinyMCE, etc.)
• All field types including checkboxes, radio buttons, selects, textareas, and more
• Hidden fields and complex parameter structures

Export File Format

The exported file is a JSON object containing all parameter names and values. Example:

{
  "param_name_1": "value1",
  "param_name_2": "value2",
  "subform_field": [
    { "subfield1": "data1" },
    { "subfield1": "data2" }
  ]
}

Importing Module Parameters

To import parameters from a previously exported JSON file:

1. Navigate to the module you want to import parameters into
2. Click on the Export/Import tab in the module edit form
3. Click the Import Parameters button
4. Select the JSON file you want to import
5. A confirmation modal will appear showing:
• Warning about data replacement
• Number of parameters that will be imported
• Important notice about the operation being irreversible
6. Click Import Now to proceed or Cancel to abort
7. After confirmation, parameters are imported and the page reloads automatically

Important Notes

• Module Must Be Saved First: The module must exist in the database (have an ID) before you can export or import
• Data Replacement: Importing will replace all existing parameters in the module
• Backup Recommended: Always export current parameters before importing new ones
• Module Type Compatibility: Imported parameters should be from a compatible module type (same field names)
• Automatic Reload: Page reloads after import to show updated parameters

Subform Data Handling

When importing subform data:

• The plugin automatically creates additional rows if needed
• All subform fields are populated correctly
• Row relationships are maintained

When to Use This Plugin

This plugin is useful in several scenarios:

Copy Module Configurations

• Copy complex module settings from one module to another
• Replicate module configurations across multiple modules
• Apply template module settings to new modules
• Clone modules with all their parameter settings

Backup and Migration

• Backup module configurations before making changes
• Export settings for migration to another Joomla site
• Create configuration snapshots for version control
• Store module templates for future use

Development Workflow

• Share module configurations between development and production sites
• Transfer settings from staging to live environment
• Document module configurations as JSON files
• Version control module parameter sets

Multi-Site Management

• Apply same module settings across multiple Joomla installations
• Maintain consistent module configurations across sites
• Deploy standardized module setups

Testing and Experimentation

• Export current settings before testing new configurations
• Quickly restore previous settings if needed
• Compare different configuration versions

How It Works

The plugin uses backend AJAX handlers for reliable data operations:

Export Process

1. JavaScript sends AJAX request with module ID
2. PHP handler queries database: SELECT params FROM #__modules WHERE id = ?
3. JSON params are decoded and returned to frontend
4. JSON file is generated and downloaded to user's computer

Import Process

1. User selects JSON file and confirms import
2. JavaScript sends AJAX request with module ID and JSON params
3. PHP handler validates data and updates database: UPDATE #__modules SET params = ? WHERE id = ?
4. Module cache is cleared
5. Page reloads to show updated parameters

Field Support

• Regular Fields: Text, number, select, checkbox, radio buttons - handled via database JSON
• Editor Fields: Uses JoomlaEditor API to get/set editor content correctly
• Subforms: Exported as arrays, imported with automatic row creation
• Hidden Fields: All parameters in database are exported regardless of visibility

Security Features

• CSRF token validation on all AJAX requests
• Permission checks (core.edit on com_modules)
• Administrator-only operation
• Input validation and JSON parsing error handling
• Database query parameterization

AJAX Endpoint

Plugin uses Joomla's com_ajax system:

index.php?option=com_ajax&plugin=modexport&group=system&format=json&action=[export|import]

• What types of modules does this work with?

  • Works with all Joomla modules - core modules (Articles, Custom HTML, Menu, etc.) and any third-party modules. Since it exports from the database, it captures all parameters regardless of module type.

• Can I export parameters from a module and import them into a different module type?

  • Technically yes, but only parameters with matching field names will be imported. It's recommended to import into the same module type for best results.

• Does this work with subform/repeatable fields?

  • Yes! The plugin fully supports subform fields. All rows are exported as arrays, and import automatically creates the required rows.

• What about editor fields like TinyMCE?

  • Editor fields are fully supported. The plugin uses JoomlaEditor API to properly extract and insert editor content.

• Can I use this to migrate modules between Joomla sites?

  • Yes, you can export parameters from one site and import them into another site, as long as both sites have the same module type installed.

• What if the module hasn't been saved yet?

  • The plugin requires the module to be saved (have a database ID) before export/import. Save the module first, then use export/import.

• Will importing overwrite my current module settings?

  • Yes, importing will replace all existing parameters. The confirmation modal warns you and shows the parameter count. Always export current settings as backup before importing.

• Is there a way to see what will be imported before confirming?

  • The confirmation modal shows the number of parameters that will be imported. You can also open the JSON file in a text editor to see the parameter names and values before importing.

• Does this work with Joomla 4, 5, and 6?

  • Yes, the plugin is fully compatible with Joomla 4.x, 5.x, and 6.x.

• Can I export from admin modules and import to site modules (or vice versa)?

  • Yes, as long as the module type is the same and has compatible parameters. The plugin works with both site and administrator modules.