Warning: You are browsing the documentation for PrestaShop 1.7, which is outdated.
You might want to look at the current version, PrestaShop 8. Read the updated version of the documentation
The Validator ( https://validator.prestashop.com ) is a tool created to check if your module is technically compatible with the PrestaShop standards. You can:
The Validator then automatically creates a detailed report explaining what needs to be improved/changed in your module. By following this report, you can submit your module error-free!
A search engine is available within the Validator to help you work out which methods are available for the various versions of PrestaShop. Make the most of this and use it to save time! It is not entirely up-to-date but we intend to work on it. You can find the search engine here.
Have you thought about saving time with our Module Generator yet? All you have to do is choose your module type and follow the instructions. A skeleton module is then automatically generated to facilitate the creation of your module.
You can create and test your module on whatever environment you like. Could be Windows using WampServer, Linux on local, docker, etc. The important thing to remember is to always activate the display of error messages.
To make this easier, PrestaShop features a Dev Mode, which allows you to configure your use of PHP to display error messages. There are 2 methods to activate Dev Mode:
<?php
define('_PS_MODE_DEV_', true);
Important: stores which are up and running must not be used in Dev Mode! https://build.prestashop-project.org/news/module-development-changes-in-17/
Read our article: Good practices for developing modules.
The Validator explains exactly what you need to modify for your module to be compliant with our technical requirements (technical errors, forbidden features or structural problems, etc.). By following the Validator’s recommendations, your module will be on sale sooner!
If you encounter any problems, you can contact the technical team when submitting your module. Take advantage of their experience to perfect your module!
All well-written 1.6 modules should work with little to no changes in version 1.7, except those which target:
What this means for any shop upgrade is that in order for a PS 1.6 to migrate to PS 1.7, you will have to:
Everything you should know is gathered in the following pages:
And of course our 1.7 Project FAQ that should already be your bedtime reading!
After creating the perfect product page using the Contributor Kit, submit your module for technical validation.
At this stage, you can find the module_key for your module. This is to be entered into the constructor in this format:
<?php
public function __construct() {
// etc.
$this->module_key = 'c1614c239af92968e5fae97f366e9961';
}
This will signal to the seller when an update of your module is available in the back-office. You should describe the modifications made one by one when an update is made. Don’t forget to indicate which versions of PrestaShop your module is compatible with!
The zip archive submitted to our team must contain all the necessary files for your module, and have the same name as your module: if the main file of your module is called “module_name.php”, then it should be in the folder “module_name”, and the zip file must have the same name - without a version number.
Make sure that the name used for your file and zip is the same that you have given to your product page (so that the online seller can quickly identify your module in the back office of their store). So think carefully about the name you choose for your product (without using either “PrestaShop” or “module”). Feel free to personalize the name, for example with the name of your company or your initials
Once your module has been verified by the technical team, you will receive an email from us informing you of its status (validated or refused).
If refused, you will be told the points to improve. You can respond directly to the team via a link in the email informing you of the refusal in order to receive further information. Then it is up to you to follow these recommendations and resubmit your module to us!