{"id":13624,"date":"2025-03-18T10:41:58","date_gmt":"2025-03-18T05:11:58","guid":{"rendered":"https:\/\/www.hiddentechies.com\/blog\/?p=13624"},"modified":"2025-07-09T16:45:01","modified_gmt":"2025-07-09T11:15:01","slug":"create-custom-prestashop-module","status":"publish","type":"post","link":"https:\/\/www.hiddentechies.com\/blog\/prestashop-tutorials\/create-custom-prestashop-module\/","title":{"rendered":"How to Create a Custom PrestaShop Module"},"content":{"rendered":"

Creating a custom module in PrestaShop allows you to extend its functionality without modifying the core files. In this tutorial, we will go step by step to create a basic custom module for PrestaShop 1.7 and later versions.<\/p>\n

Step 1: Create the Module Folder and Files<\/h3>\n

Navigate to the modules<\/code> directory of your PrestaShop installation and create a new folder for your module. Let’s name it mycustommodule<\/code>.<\/p>\n

Inside the mycustommodule<\/code> folder, create a PHP file named mycustommodule.php<\/code>. This will be the main file for your module.<\/p>\n

Step 2: Define the Module Class<\/h3>\n

Open mycustommodule.php<\/code> and add the following code:<\/p>\n

<?php\r\nif (!defined('_PS_VERSION_')) {\r\n    exit;\r\n}\r\n\r\nclass MyCustomModule extends Module\r\n{\r\n    public function __construct()\r\n    {\r\n        $this->name = 'mycustommodule';\r\n        $this->tab = 'front_office_features';\r\n        $this->version = '1.0.0';\r\n        $this->author = 'Your Name';\r\n        $this->need_instance = 0;\r\n        \r\n        parent::__construct();\r\n\r\n        $this->displayName = $this->l('My Custom Module');\r\n        $this->description = $this->l('A simple custom module for PrestaShop.');\r\n    }\r\n}<\/code><\/pre>\n
Step 3: Install and Uninstall Methods<\/h3>\n
Add the following methods inside the MyCustomModule<\/code> class to handle installation and uninstallation:<\/p>\n
public function install()\r\n{\r\n    return parent::install() && Configuration::updateValue('MYCUSTOMMODULE_TEXT', 'Default Value');\r\n}\r\n\r\npublic function uninstall()\r\n{\r\n    return parent::uninstall() && Configuration::deleteByName('MYCUSTOMMODULE_TEXT');\r\n}<\/code><\/pre>\n
Step 4: Register a Hook<\/h3>\n
To display content in a specific part of your PrestaShop store, register a hook. Let’s hook into the displayHome<\/code> hook to show a message on the homepage:<\/p>\n
public function install()\r\n{\r\n    return parent::install() && $this->registerHook('displayHome');\r\n}\r\n\r\npublic function hookDisplayHome($params)\r\n{\r\n    return '<p>Welcome to my custom module!<\/p>';\r\n}<\/code><\/pre>\n
Step 5: Create a Basic Configuration Page<\/h3>\n
To allow users to modify module settings, add the getContent<\/code> method for an admin configuration form:<\/p>\n
public function getContent()\r\n{\r\n    $output = '';\r\n    if (Tools::isSubmit('submitMyCustomModule')) {\r\n        $customText = Tools::getValue('MYCUSTOMMODULE_TEXT');\r\n        Configuration::updateValue('MYCUSTOMMODULE_TEXT', $customText);\r\n        $output .= $this->displayConfirmation('Settings updated');\r\n    }\r\n    \r\n    return $output . $this->renderForm();\r\n}\r\n\r\nprivate function renderForm()\r\n{\r\n    $fieldsForm = [\r\n        'form' => [\r\n            'legend' => [\r\n                'title' => $this->l('Settings'),\r\n            ],\r\n            'input' => [\r\n                [\r\n                    'type' => 'text',\r\n                    'label' => $this->l('Custom Text'),\r\n                    'name' => 'MYCUSTOMMODULE_TEXT',\r\n                    'size' => 20,\r\n                    'required' => true,\r\n                ]\r\n            ],\r\n            'submit' => [\r\n                'title' => $this->l('Save'),\r\n                'class' => 'btn btn-default pull-right'\r\n            ]\r\n        ]\r\n    ];\r\n\r\n    $helper = new HelperForm();\r\n    $helper->table = $this->table;\r\n    $helper->default_form_language = (int) Configuration::get('PS_LANG_DEFAULT');\r\n    $helper->allow_employee_form_lang = Configuration::get('PS_BO_ALLOW_EMPLOYEE_FORM_LANG') ? Configuration::get('PS_BO_ALLOW_EMPLOYEE_FORM_LANG') : 0;\r\n    $helper->identifier = $this->identifier;\r\n    $helper->submit_action = 'submitMyCustomModule';\r\n    $helper->currentIndex = AdminController::$currentIndex . '&configure=' . $this->name;\r\n    $helper->token = Tools::getAdminTokenLite('AdminModules');\r\n    \r\n    $helper->fields_value['MYCUSTOMMODULE_TEXT'] = Configuration::get('MYCUSTOMMODULE_TEXT');\r\n\r\n    return $helper->generateForm([$fieldsForm]);\r\n}<\/code><\/pre>\n
Step 6: Install the Module<\/h3>\n
    \n
  1. Zip the mycustommodule<\/code> folder.<\/li>\n
  2. Go to PrestaShop Back Office > Modules > Module Manager<\/strong>.<\/li>\n
  3. Click Upload a module<\/strong> and select your zip file.<\/li>\n
  4. Install and activate the module.<\/li>\n
  5. Configure the module in the admin panel by modifying the custom text field.<\/li>\n<\/ol>\n
    Now, your module should display a message on the homepage!<\/p>\n
    Conclusion<\/h3>\n
    This tutorial covered the basics of creating a PrestaShop module, including an admin configuration page. You can extend it further by adding more hooks, a database table, or advanced settings to enhance the module’s functionality.<\/p>\n
    <\/div>
     <\/a>
    <\/div><\/div><\/div>
    <\/div>","protected":false},"excerpt":{"rendered":"
    Creating a custom module in PrestaShop allows you to extend its functionality without modifying the core files. In this tutorial, we will go step by step to create a basic custom module for PrestaShop 1.7 and later versions. Step 1: Create the Module Folder and Files Navigate to the modules directory of your PrestaShop installation… <\/p>\n
    Continue Reading<\/a><\/div>\n","protected":false},"author":1,"featured_media":13656,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[221,222,2509,2527,2305,2139,1],"tags":[2540,2548,2542,2545,2541,2547,2546,2543,2544,2539],"_links":{"self":[{"href":"https:\/\/www.hiddentechies.com\/blog\/wp-json\/wp\/v2\/posts\/13624"}],"collection":[{"href":"https:\/\/www.hiddentechies.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.hiddentechies.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.hiddentechies.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.hiddentechies.com\/blog\/wp-json\/wp\/v2\/comments?post=13624"}],"version-history":[{"count":4,"href":"https:\/\/www.hiddentechies.com\/blog\/wp-json\/wp\/v2\/posts\/13624\/revisions"}],"predecessor-version":[{"id":13629,"href":"https:\/\/www.hiddentechies.com\/blog\/wp-json\/wp\/v2\/posts\/13624\/revisions\/13629"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.hiddentechies.com\/blog\/wp-json\/wp\/v2\/media\/13656"}],"wp:attachment":[{"href":"https:\/\/www.hiddentechies.com\/blog\/wp-json\/wp\/v2\/media?parent=13624"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.hiddentechies.com\/blog\/wp-json\/wp\/v2\/categories?post=13624"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.hiddentechies.com\/blog\/wp-json\/wp\/v2\/tags?post=13624"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}