Coding Standards-
Last updated
Was this helpful?
Last updated
Was this helpful?
Consistency is important, even more so when writing open-source code, since the code belongs to millions of eyeballs, and bug-fixing relies on these teeming millions to actually locate bugs and understand how to solve it.
This is why, when writing anything for PrestaShop, be it a theme, a module or a core patch, you should strive to follow the following guidelines. They are the ones that the PrestaShop developers adhere to, and following them is the surest way to have your code be elegantly integrated in PrestaShop.
In short, having code consistency helps keeping the code readable and maintainable.
Starting with version 1.6.1.0, the PrestaShop Core codebase has switched to the and . See the reasons why on the on the Build PrestaShop deblog.
Existing modules and themes are not required to switch to PSR-1 and PSR-2. PrestaShop's own modules and any newly-created community module are expected to adopt these guidelines.
If you want to update your PHP code to the PSR-1 and PSR-2 guidelines, you can use the , which fixes most issues automatically.
For reference's sake, the old PrestaShop coding standards is kept in this page: . Please do not use it anymore!
As of May 10th, 2016, our chosen standards were further detailed. .
Here are the standards, conventions and guidelines that we choose to follow as of May 10th, 2016 (for PrestaShop 1.6.1.5+ and PrestaShop 1.7):
PHP code We keep and , along with .
JavaScript code We choose to follow the .
HTML & CSS code We choose to follow the . Mark is the creator of .
Smarty / Twig code Same standards as with HTML & CSS.
Commits & Pull-requests conventions .
SQL guidelines .
The CodeSniffer configuration file is not yet available. Thank you for your patience!