Child pages
  • Your Modules
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Modules

The "Modules" page under the "Modules" menu gives you access to the list of modules. On this page you can install, uninstall, and configure each module.

Above and below the page title, you will at times get notifications from installed modules. Most of the time, the notification help you complete the configuration of modules that are installed but not yet ready to be used: updating their setting should make the notification disappear... and your module work properly.

Above the table of modules are two buttons, titled "Normal view" and "Favorites view". They radically change the way modules are listed.

Normal view

This is the default view. It enables you to quickly find the module you want to install or edit the settings of.

The first section is where you can search for a specific module, or filter down modules until you find the one you are looking for.

  • Search field. Modules are displayed while you type their name, which makes it even more intuitive and fast.
  • 'Sort by' selectors. The list automatically reloads when you make a selection, and displays modules according to all the current settings.
    • All modules.
      • Free modules. The ones that were in the default distribution of PrestaShop, i.e. not modules that you added afterwards.
      • Partner modules (free). Modules that were created for PrestaShop partners. Most of the time, they enable your shop to work with the partner's third-party service.
      • Must have. Essential modules, as selected by the Addons team.
      • Author. You can filter the modules by author. Be default, only "PrestaShop" is available, but as add more modules, this selector will prove very useful.
      • Other modules. Modules that are neither native, nor made for PrestaShop partners. They are often written by independent developers, but can also be written by the PrestaShop team.
    • Installed & Not Installed. Most of the time, you will want to perform an action on an installed module, or install a new one. This filter is the most commonly used.
    • Enabled & Disabled. Installed module are the only ones that can be configured, hence the importance of this selector.
    • All countries. Some modules are country-specific. This selector enables you to only see the ones which are tailor-made for your shop's country.

On the left is a list of all the module categories, with the number of modules for each in brackets. Click on a category in order to display the modules for this category.
One of the categories is named "Favorites" and is empty by default. This enables you to gather the modules you most often use, and to access them quickly. You can set your favorite modules using the "Favorites" view.

Modules can have one of 4 statuses, each with specific color:

  • Non-installed: orange.
  • Installed but disabled: gray.
  • Installed and enabled: green.
  • Installed and enabled, but with warnings: red.

There is one additional "status": "Must have", in orange. Modules with this status are actually promoted from the Addons website. They are not free: the "Install" button is replaced by a shopping cart button, with the price of the module. Clicking that button open the module's page on the Addons website, where you can buy the module.

Most of the time, warnings are a reminder that you have not properly configured the module. Click its "Configure" link and go through the various needed steps.

Difference between disabling and uninstalling

When you do not have a use for a module anymore, you can either disable or uninstall it. The result of both actions is seemingly the same: the module is not available anymore, its options do not appear in your back-office and any element it would add to your front-end disappears.

The difference is that disabling a module keeps its configuration safe for a later re-enabling, while uninstalling removes all configuration and database data.

Therefore, only uninstall a module if you do not care about its data or if you are certain that you would not need it. If you are really sure you do not want that module on your shop, you can even click on its "Delete" link.

Some modules have "(Addons)" at the end of their name. This means the modules will not be installed from files on your server, but downloaded from the Addons website. It helps ensure that you always have the latest version of a module.

Still, installing a module from files that are downloaded from the Addons servers is no different for PrestaShop from installing it from files that are already on your server.

Favorites view

This view gives a whole different presentation of your modules: gone is the list of category selectors, the install/uninstall buttons and the action links.

This view gives an alphabetical list of all your modules, both installed or not, their categories in plain text and two drop-down menus:

  • Interest. If set to "No", the module will not appear in your module list at all. If set to "Yes" or "--", it will.
  • Favorite. If set to "Yes", the module will appear in the "Favorites" category. If set to "No" or "--", it will not.

Since these can be two contradictory settings, mixing them can result in unexpected results. They remain quite logical: in short, "Interest" surpasses "Favorites".

Interest

Favorite

Appears in module list?

Appears in "Favorites" category?

Yes

Yes

Yes

Yes

No

Yes

No

No

Yes

No

Yes

No

No

No

No

No

Since v1.5.4, you can use the selector from the "Tab" column to indicate in which contextual page the module should appear. This has a direct impact on each page's "Modules list" button. If no selection is made, the module will appear in its default contextual page.

You cannot perform any other action on the available modules using this view: installing, configuring, and others must be done in normal view.

Performing Actions on Modules

All actions are performed in the normal view.

  • Uninstalled modules:
    • Install. This will trigger the installation of the module on your installation of PrestaShop. The module will be automatically enabled. It might add new options to your back-office.
    • Delete. This will remove the module from the modules list, and delete its files and folders from your server.
  • Installed modules:
    • Disable. When installed, a module is enabled by default. You can disable it, which will remove its options from your back-office, but will keep its settings for a later re-enabling.
    • Reset. This will restore the module's settings to their defaults.
    • Delete. This will remove the module from the modules list, and delete its files and folders from your server.
    • Configure. Some modules have a configuration page. In that case, they offer a "Configure" link to access a new interface where the user will be able to adjust all its settings.

Top ranking modules from Addons can be promoted to your module list, depending on your country settings. They appear among regular modules, but their action buttons are not labeled "Install" but instead "Buy - 30 €", for instance. Clicking on the button takes you to the module's Addons page, from which you can log in, buy and download the module. From there on, you can install it on your shop.

Configuring the Native Modules

All the native modules are explained in depth in their own chapter, "Making The Native Modules Work".

  • No labels