Warning: You are browsing the documentation for PrestaShop 1.7, which is outdated.
You might want to read an updated version of this page for the current version, PrestaShop 8. Read the updated version of this page
$this->author = "Some Company";
This attribute contains the name of the module’s author. It is displayed as-is in the PrestaShop modules list.
$this->bootstrap = true;
This attribute indicates that the module’s template files have been built with PrestaShop 1.6+ bootstrap tools in mind – and therefore, that PrestaShop should not try to wrap the template code for the configuration screen (if there is one) with helper tags.
We recommend setting this to
true, unless you specifically need it deactivated.
Note: this option has no effect in Symfony controllers.
$this->confirmUninstall = "Are you sure? Deleting this module will make kittens sad :(";
This attribute contains a confirmation message to be displayed when a user attempts to uninstall this module.
$this->description = "This module does great things with your shop.";
This attribute contains the module’s description that will be displayed in module listings.
$this->displayName = "My wonderful module";
This attribute contains the module name that will be displayed in module listings.
$this->name = "mymodule";
This attributes serves as an internal identifier (technical name). The value MUST be the same as the module’s folder and main class file. Only lower case letters and numbers are accepted.
$this->need_instance = 1;
Indicates whether to load the module’s class when displaying the “Modules” page in the back office. If set to
0, the module will not be loaded, and therefore will spend less resources to generate the “Modules” page. If your module needs to display a warning message in the “Modules” page, then you must leave this attribute to
$this->ps_versions_compliancy = [ 'min' => '1.6', 'max' => '126.96.36.199', ];
Indicates which versions of PrestaShop this module is compatible with. The
max values define the lower and higher bound of the compatibility range. The example above describes a compatibility range from
PrestaShop will refuse to install the module if the current shop version is not within the module’s compatibility range.
max) to the most recent version of PrestaShop that you have actually tested your module with. Don’t assume that if your module has been verified to work with, say, 188.8.131.52, it will automatically work well in all subsequent 1.7 versions.
$this->tab = 'front_office_features';
The title for the section that shall contain this module in PrestaShop’s back office modules list.You may use an existing name, such as
analytics_stats, or a custom one. In this last case, a new section will be created with your identifier.
Here are the available “Tab” attributes, and their corresponding section in the “Modules” page:
|“Tab” attribute||Module section|
||Advertising & Marketing|
||Analytics & Stats|
||Taxes & Invoices|
||Front Office Features|
||Internationalization & Localization|
||Payments & Gateways|
||Site certification & Fraud prevention|
||Pricing & Promotion|
||Quick / Bulk update|
||Search & Filter|
||Shipping & Logistics|
||Comparison site & Feed management|
||Social & Community|
$this->version = '1.0.5';
The version number for the module, displayed in the modules list. We recommend following the Semantic Versioning specification.