PrestaShop 9 Module Development: Advanced Techniques and Best Practices

Working with Hooks

Understanding Hooks

Hooks are the backbone of PrestaShop’s extensibility. They allow your module to inject code at specific points in the application flow. Think of them as “insertion points” where your module can add functionality.

Common Hooks

• displayHeader – Add content to the page header
• displayHome – Add content to the homepage
• displayProductActions – Add buttons to product pages
• actionOrderStatusUpdate – Trigger when order status changes
• displayCustomerAccount – Add content to customer account
• actionValidateOrder – Trigger when order is validated

Creating Custom Hooks

Sometimes you need to create your own hooks for other modules to use:

// In your module
public function hookDisplayCustomHook($params)
{
    return $this->display(__FILE__, 'views/templates/hook/custom-hook.tpl');
}

// Register the hook
Hook::register('displayCustomHook', 'MyModule');

// Other modules can now use your hook
public function hookDisplayCustomHook($params)
{
    // Their code here
}

Database Integration

Creating Database Tables

Most modules need to store data. Here’s how to create database tables properly:

// sql/install.sql
CREATE TABLE IF NOT EXISTS `PREFIX_my_module_data` (
    `id_my_module_data` int(11) NOT NULL AUTO_INCREMENT,
    `id_product` int(11) NOT NULL,
    `custom_field` varchar(255) NOT NULL,
    `date_add` datetime NOT NULL,
    `date_upd` datetime NOT NULL,
    PRIMARY KEY (`id_my_module_data`),
    KEY `id_product` (`id_product`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

Database Operations

Use PrestaShop’s database classes for safe database operations:

// Insert data
$data = [
    'id_product' => (int)$idProduct,
    'custom_field' => pSQL($customValue),
    'date_add' => date('Y-m-d H:i:s'),
    'date_upd' => date('Y-m-d H:i:s')
];

Db::getInstance()->insert('my_module_data', $data);

// Select data
$result = Db::getInstance()->executeS('
    SELECT * FROM ' . _DB_PREFIX_ . 'my_module_data 
    WHERE id_product = ' . (int)$idProduct
);

// Update data
Db::getInstance()->update('my_module_data', 
    ['custom_field' => pSQL($newValue)], 
    'id_product = ' . (int)$idProduct
);

Admin Controllers

Creating Admin Panels

Admin controllers allow store owners to configure your module. Here’s how to create them:

// controllers/admin/AdminMyModuleController.php
<?php class AdminMyModuleController extends ModuleAdminController { public function __construct() { $this->table = 'my_module_data';
        $this->className = 'MyModuleData';
        $this->identifier = 'id_my_module_data';
        $this->lang = false;
        $this->bootstrap = true;
        
        parent::__construct();
        
        $this->fields_list = [
            'id_my_module_data' => [
                'title' => $this->l('ID'),
                'align' => 'center',
                'class' => 'fixed-width-xs'
            ],
            'id_product' => [
                'title' => $this->l('Product'),
                'align' => 'left'
            ],
            'custom_field' => [
                'title' => $this->l('Custom Field'),
                'align' => 'left'
            ],
            'date_add' => [
                'title' => $this->l('Date Added'),
                'align' => 'right',
                'type' => 'datetime'
            ]
        ];
    }
}

Configuration Forms

Create configuration forms for module settings:

public function getContent()
{
    $output = '';
    
    if (Tools::isSubmit('submit' . $this->name)) {
        $my_setting = Tools::getValue('MY_MODULE_SETTING');
        Configuration::updateValue('MY_MODULE_SETTING', $my_setting);
        $output .= $this->displayConfirmation($this->l('Settings updated'));
    }
    
    return $output . $this->displayForm();
}

public function displayForm()
{
    $fields_form = [
        'form' => [
            'legend' => [
                'title' => $this->l('Settings'),
            ],
            'input' => [
                [
                    'type' => 'text',
                    'label' => $this->l('My Setting'),
                    'name' => 'MY_MODULE_SETTING',
                    'size' => 40,
                    'required' => true
                ]
            ],
            'submit' => [
                'title' => $this->l('Save'),
                'class' => 'btn btn-default pull-right'
            ]
        ]
    ];
    
    $helper = new HelperForm();
    $helper->submit_action = 'submit' . $this->name;
    $helper->fields_value['MY_MODULE_SETTING'] = Configuration::get('MY_MODULE_SETTING');
    
    return $helper->generateForm([$fields_form]);
}

Frontend Integration

Template Integration

Integrate your module with the frontend using Smarty templates:

// views/templates/hook/display-home.tpl

JavaScript Integration

Add JavaScript functionality to your module:

// views/js/front.js
$(document).ready(function() {
    $('.my-module-button').on('click', function(e) {
        e.preventDefault();
        
        $.ajax({
            url: myModuleAjaxUrl,
            type: 'POST',
            data: {
                action: 'myModuleAction',
                id_product: $(this).data('product-id')
            },
            success: function(response) {
                if (response.success) {
                    // Handle success
                }
            }
        });
    });
});

Security Best Practices

Input Validation

Always validate and sanitize user input:

• Use Tools::getValue() – For getting POST/GET data
• Validate data types – Check if data is the expected type
• Use pSQL() – For database queries
• Use (int) – For integer values
• Use (float) – For decimal values

CSRF Protection

Protect your forms against CSRF attacks:

// In your form


// In your controller
if (!Tools::getIsset('token') || 
    !Tools::getValue('token') === Tools::getToken(false)) {
    die('Invalid token');
}

Performance Optimization

Caching Strategies

Use caching to improve module performance:

• Use PrestaShop’s cache – Cache expensive operations
• Lazy loading – Load data only when needed
• Database optimization – Use proper indexes
• Minimize database queries – Combine queries when possible

Code Optimization

• Use autoloading – Don’t include files manually
• Minimize file includes – Only include what you need
• Use efficient loops – Avoid nested loops when possible
• Profile your code – Use Xdebug to find bottlenecks

Testing and Debugging

Unit Testing

Write tests for your module functionality:

// tests/MyModuleTest.php
class MyModuleTest extends PHPUnit_Framework_TestCase
{
    public function testModuleInstallation()
    {
        $module = new MyFirstModule();
        $this->assertTrue($module->install());
        $this->assertTrue($module->uninstall());
    }
    
    public function testDatabaseOperations()
    {
        // Test your database operations
    }
}

Debugging Techniques

• Use PrestaShop’s debug mode – Enable debug mode for development
• Log errors – Use PrestaShop’s logging system
• Use Xdebug – For step-by-step debugging
• Check error logs – Monitor server error logs

Module Distribution

Packaging Your Module

Package your module properly for distribution:

• Create a ZIP file – Include all necessary files
• Write documentation – Installation and usage guide
• Include changelog – Document version changes
• Test installation – Test on fresh PrestaShop installation
• Validate with PrestaShop – Use the PrestaShop Validator

Version Control

• Use semantic versioning – MAJOR.MINOR.PATCH
• Tag releases – Create Git tags for releases
• Maintain changelog – Document all changes
• Backward compatibility – Don’t break existing installations

Advanced Techniques

Custom Models

Create custom models for complex data operations:

// classes/MyModuleData.php
class MyModuleData extends ObjectModel
{
    public $id_my_module_data;
    public $id_product;
    public $custom_field;
    public $date_add;
    public $date_upd;
    
    public static $definition = [
        'table' => 'my_module_data',
        'primary' => 'id_my_module_data',
        'fields' => [
            'id_product' => ['type' => self::TYPE_INT, 'validate' => 'isUnsignedId'],
            'custom_field' => ['type' => self::TYPE_STRING, 'validate' => 'isGenericName'],
            'date_add' => ['type' => self::TYPE_DATE, 'validate' => 'isDate'],
            'date_upd' => ['type' => self::TYPE_DATE, 'validate' => 'isDate']
        ]
    ];
}

AJAX Controllers

Create AJAX controllers for dynamic functionality:

// controllers/front/ajax.php
class MyModuleAjaxModuleFrontController extends ModuleFrontController
{
    public function initContent()
    {
        parent::initContent();
        
        $action = Tools::getValue('action');
        
        switch ($action) {
            case 'myModuleAction':
                $this->handleMyModuleAction();
                break;
            default:
                die('Invalid action');
        }
    }
    
    private function handleMyModuleAction()
    {
        $idProduct = (int)Tools::getValue('id_product');
        
        // Your logic here
        
        die(json_encode(['success' => true]));
    }
}