File structure

Here’s the typical directory structure of a PrestaShop install:

.
├── admin
├── app
├── bin
├── cache
├── classes
├── config
├── controllers
├── docs
├── download
├── img
├── install
├── js
├── localization
├── mails
├── modules
├── override
├── pdf
├── src
├── tests
├── tests-legacy
├── themes
├── tools
├── translations
├── travis-scripts
├── upload
├── var
├── vendor
└── webservice

Folder reference

/admin

The admin directory contains the main endpoint to access the Back Office. When accessing this folder with your browser, you will be asked your employee credentials.

For an added security layer, consider protecting this folder with a .htaccess or .htpasswd file.

This directory is named admin-dev when using PrestaShop from source code, and is renamed automatically when you install it from a ZIP package.

It contains the following subdirectories:

  • /autoupgrade: scratch directory for the 1-click upgrade module
  • /backups: contains database backups generated from the Back office
  • /export: contains data export files
  • /filemanager: sources for the Back office file manager
  • /import: contains data import files
  • /themes: contains the templates for two back office themes, default and new-theme.

/app

This directory contains the configuration for the bundles and the framework.

It contains the following subdirectories:

  • /config: configuration files for database, parameters, services, etc.
  • /logs: execution logs
  • /Resources: different resources for the software, most notably the /translations subdirectory which contains translation resources for all the installed languages.
  • /test: reserved

This directory also includes the AppKernel.php file, which configures the Symfony application.

/bin

Contains executable binaries installed by the framework, such as the Symfony console.

/cache

Contains temporary cache files. No longer used by PrestaShop but kept for backwards compatibility.

/classes

Contains all the legacy classes, including:

  • Object models
  • Utility classes (like Db, Helper, Tools…)
  • Base controlllers (like FrontController, AdminController…)

/config

Contains bootstrapping and configuration files. Unless asked, you should never edit them, as they are directly handled by PrestaShop’s installer and back office.

/controllers

Contains controllers – as in Model-View-Controller (or MVC), the software architecture used by PrestaShop. Each file controls a specific part of PrestaShop.

Controllers are separated in two directories:

  • /admin: contains legacy controllers for the Back Office
  • /front: contains controllers for the Front Office

/docs

Contains documentation files, licenses, sample import files, and more.

You should delete this directory in a production environment.

/download

Contains your virtual products, which can be downloaded by the customers who bought them. Files are stored with an md5 filename.

/img

Contains all of PrestaShop’s default images, icons and picture files – that is, those that do not belong to the theme.

It contains the following subdirectories:

  • /admin: Back office images
  • /c: Category pictures
  • /cms: CMS pictures
  • /co: Attributes (colors) pictures
  • /flags: Country & language flags 1.7.7
  • /genders: Gender (Shop Parameters > Customers > Client titles) pictures
  • /jquery-ui: jQuery UI images
  • /l: Language pictures
  • /m: Manufacturer pictures
  • /os: Order state pictures
  • /p: Product pictures
  • /s: Carrier pictures
  • /scenes: Category scene pictures (removed since 1.6)
  • /st: Stores (Shop Parameters > Contact > Stores) pictures
  • /su: Supplier pictures
  • /t: Tab icons
  • /tmp: Temporary pictures

/install

Contains all the files related to PrestaShop’s installer. This directory is named install-dev when using PrestaShop from source code.

For security reasons, you will be required to delete this directory after installation.

/js

Contains JavaScript files that are not attached to themes. Most of them belong to the back office.

This is also where you will find the jQuery framework.

/localization

Contains all of PrestaShop’s localization packs — that is, files that contain local information such as default currencies and languages, tax rules and tax rule groups, states and measurement units in use in each country.

The CLDR database is also located in this directory.

/mails

Contains all HTML and text templates for e-mails sent by PrestaShop. Each language has its specific folder, where you can manually edit their content if you wish. PrestaShop contains a tool to edit your e-mails, located in the back office, in the Localization > Translation page.

Since 1.7.6 this directory also contains Mail themes.

/modules

Contains all of PrestaShop’s modules, each in its own folder.

If you wish to definitely remove a module, it is better to uninstall it from the back office.

/override

Contains class overrides. To learn more about this feature, read the Overrides section.

Note: overrides are not recommended for modules that you intend to distribute/sell, and are strictly forbidden in partner modules. Keep them for your own shop.

/pdf

Contains all the template files (.tpl) related to PDF file generation (invoice, delivery slips, etc.). Change these files in order to change the look of the PDF files that PrestaShop generates.

/src

Contains the new architecture files (Core, Adapter and PrestaShop Bundle). To learn more, see Understanding the “src” folder.

/tests

Contains automated tests. This directory is not included in release packages.

Tests are split in three big families:

  • Integration: contains behavior and integration tests.
  • E2E (or UI since 1.7.7 ): contains end-to-end tests.
  • Unit: contains unit tests.

/tests-legacy

Contains old automated tests currently being rewritten. This directory is not included in release packages.

/themes

Contains all the currently installed themes, each in its own folder.

It also includes the core.js library.

/tools

Contains development tools. This directory is not included in release packages.

It contains the following subdirectories:

  • /assets: Script that allow building all static assets from sources.
  • /build: Used to create release packages.
  • /foreignkeyGenerator: Creates forign keys for all tables (for educational purposes only)
  • /profiling: Profiling tools for legacy classes

/translations

Contains zip packages for the translation packs you downloaded.

/travis-scripts

Contains Travis-specific scripts (we use Travis as our CI management system for pull requests). This directory is not included in release packages.

/upload

Contains the files that would be uploaded by clients for customizable products (for instance, a picture that a client wants to have printed on a mug).

/var

Contains various files needed by PrestaShop for its internal operation, including cache files, log files, sessions files …

/vendor

Contains various 3rd-party libraries required by PrestaShop through Composer, such as Symfony, Doctrine, Guzzle, etc.

/webservice

Contains the main endpoint for the Webservice API.

Folders removed in 1.7

The following root folders have been removed between 1.6 and 1.7:

  • /css: contained all the CSS files that are not attached to themes – hence, these were mostly used by the PrestaShop back office, and have now been moved to the theme.css file in the /admin/themes/new-theme/public folder.
  • /log: contains the log files generated by PrestaShop at various stages, for instance during the installation process.