Page History

...

A PrestaShop module consists of :

...

• One file for PrestaShop 1.4: logo.gif, 16*16 pixels.
• One file for PrestaShop 1.5: logo.png, 32*32 pixels.

...

a main PHP file with as many other PHP file as needed, and all the image and TPL files necessary to display the information.

Let's see an example with PrestaShop's blockuserinfo module:

...

A module is made of a lot of files, all stored in a folder that bears the same name as the module, that folder being in turn stored in the /modules folder at the root of the main PrestaShop folder: /modules/name_of_the_module/.

Default files and folders for a PrestaShop 1.5 module:

• "Bootstrap" Main file: name_of_the_module.php. This PHP file should have the same name as its root folder.
• Cache configuration file (generated by PrestaShop): config.xml
• Module-specific controllers, all in the /controllers sub-folder
• Class-overriding code, all in the /override sub-folder (automatic install/uninstall using copy or merge)
• View files: JavaScript, images, CSS files, template files, etc. They can be placed in folders within the module's main folder:
  
  • /css folder for CSS files
  • /img folder for image files
  • /js folder for JavaScript files
  • /views/templates/admin sub-folder for files used by the module's admin controller
  • /views/templates/front sub-folder for files used by the module's front controller
  • /views/templates/hook sub-folder for files used by the module's hooks
• 16x16 module logo: logo.jpg (JPG format)
• 32x32 module logo: logo.png (PNG format)Module-specific controllers, all in the /controllers sub-folder
• Class-overriding code, all in the /override sub-folder (automatic install/uninstall using copy or merge)
• Two icon files representing this module in the back-office.
  • One file for PrestaShop 1.4: logo.gif or logo.jpg, 16*16 pixels.
  • One file for PrestaShop 1.5: logo.png, 32*32 pixels.
• Translation files: fr.php, en.php, es.php, etc. From v1.5 onward, all these files can be placed in the /translations sub-folder.
• Optional: in a /themes/[theme name]/modules folder, a folder with the same name as the module, containing .tpl and language files if necessary. This last folder is essential during modifications of existing module, so that you can adapt it without having to touch its original files. Notably, it enables you to handle the module's display in various ways, according to the current theme.

Creating a first module

Let's create a simple first module; this will enable us to better describe its structure. We will call it "My module".

...