Child pages
  • Managing Modules and Themes

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The first section is where you can search for a specific module, or filter down module 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 selectselection, and displays modules according to all the current settings.
    • All modules.
      • Native 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, 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 that 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 module category in order to filter the displayed moduledisplay the modules for this category.
One of the categories is named "Favorites" and is empty by default. This serves as a quick way to access enables you to gather the modules you most often need use, and to access tothem quickly. You can set your favorite modules using the "Favorites" view.

...

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

Info
titleDifference 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.

Tip

Some modules have "(Addons)" at the end of their name – mostly the payment modules. 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 server servers is no different for PrestaShop from installing it from files that are already on your server.

...

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

...

  • 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 need their own 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.
Info

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 installation install it on your PrestaShop installationshop.

Configuring The Native Modules

...

To install a new PrestaShop module automatically, click on the "Add a new module from my computer" link at the top of the list of modules, in the "Modules" page. A new section will slide open.

...

The form in this section enables you to upload the archive file of the module, as downloaded from Addons. You can either upload a zip file, or a tar.gz one (tarball). The form is straightforward: simply browse to the module's file that you downloaded, and click the "Upload this module" button. Do not point to the module's uncompressed folder or any of its unpacked files!

Info

In previous version of PrestaShop, you could upload the module's zip file on your FTP server and point the form to that file's URL.
This feature has been taken out of PrestaShop 1.5 for security reasons.

...

The "Import/export a theme" theme module is a native module, and should be installed by default. This is a special module that enables you to import a theme and install it (and its attached modules), or to export a theme and its modules from your shop in order to share it with the world.

Find this module in the module list (in the "Modules" page), and configure it to reach open its configuration screen. This screen presents you with 3 methods to install a new module: from your computer, from a public website, or from your own FTP server. It also gives you a method to export your module in a correct format.

...

A quick summary is displayed in the next page, indicating what that importer is about to do..

Click "Next" again to validate your choice. The theme is now installed, and PrestaShop asks you if you wish to install modules that were imported along with the theme, what you would rather do with the current modules configuration, and how you would like the images configuration to be taken into account.

Click "Next" one last time. A final confirmation page presents you with all the changes applied to your PrestaShop installsite. Click "Finish" to end the process.

...

This section is only available when there is at least one theme installed on your PrestaShop site.
Exporting a theme is very useful when you want either to back the theme up for safety, and create an archive of the theme for a friend or in order to make it available on the Addons marketplace (http://addons.prestashop.com/fr/). Not only does it generate a complete Zip archive of your theme, but it also adds many information in an XML files, which is very useful both when uploading to Addons, and when important importing to another PrestaShop site.

Select a theme and click on "Export this theme". A configuration form appears where you can set the exported themes parameters: author, modules, theme name, compatibility version, attached modules (if any), etc.

Once all the parameters are correctly set, click on "Generate the archive now". You will quickly get a file to download from your browser. Save it on your hard-drive, then give the save file a proper name. From there on, you can easily share this theme, and if it is your own creation, you can start selling it on PrestaShop's Addons website at http://addons.prestashop.com/.

...

  1. Unzip (decompress) the theme archive file (.zip). This should result in at least one new local folder, /themes, containing your theme's folder(s).
  2. Using your FTP client, place the theme's folder (as found in the local /themes folder) online in your PrestaShop /themes folder. Pay attention NOT to upload that folder in another theme's folder (which can happen when drag-and-dropping items). Upload the whole folder, not just the files it contains.
  3. (optional) If the theme's archive contains a second /modules folder, it means your new theme comes bundled with modules that are specific to it, or necessary for it to run properly. Using your FTP client, place the folder(s) found in the local /modules folder online in your PrestaShop /modules folder. If your online PrestaShop install already has a module of the same name, try to only keep the most recent version of the two (the one with the most recent files). If unsure, keep the version bundled with the theme, as it is the most likely to work best with it.
  4. Go to your back-office, in the "Modules" tab then it "Themes" sub-tabThemes" page under the "Preferences" menu.
  5. Select the new theme in place of the current theme, by clicking on the radio button then clicking "Save".
  6. Your module theme is now in place.
  7. (optional) If the theme came with modules, activate them on the back-office's "Modules" tab within the PrestaShop adminpage, then configure them if need be.

...

The position of a module in your theme can be changed, because you might want one module's block to be placed much higher (or lower) in the page that others. In PrestaShop's parlance, this is called "transplanting", and is done using the tool available in the "Positions" page, under the "Modules" menu. In effect, this enables you to attach a module to one of the many available hooks in the current theme, without writing any code.

...

Info

Make sure to disable the cache when testing the effect of a new hook module on the front-end. You can do this in the "Preferences" page, under the "Advanced parameters" menu.

...

Each module has two icons on the right side of its row: one to edit its settings, the other to delete the iconmodule.

Editing a module's setting uses the same interface as the one created used for the transplanting a module. The major difference is that you cannot change the "Module" and "Hook into" settings, as they are disabled, and thus grayed out. You can only edit the exception setting, which works just as described in the "Attaching a module to a hook" method above.
While you cannot edit the "Module" and "Hook into" settings, they can serve as a handy reminder of their current position, should you want to put them back there later on.

...

  • Removing a single module: click the trashcan icon on the right of the module's row.
  • Removing a batch of modules: select the modules by checking the box on the right of their row, and then click the "Unhook" button, found at the top and the bottom of the list of hooks.

Transplanting a module visually: Live Edit

...

The first one is quite self-explanatory; the second one cancels all changes you might have made to your modules' position during this live-editing session.

Warning

Once you have save your changes after having removed a module, if you want to bring it back, you will have to go to the "Positions" page and use the "Transplant a module" toolform.

Where to move modules?

Modules cannot be moved just about anywhere: it depends on both the theme's hooks, and each module's hook support (as seen in the above section). Therefore, you mostly can only move modules within their understood context: column modules can be moved within a column as well as from one column to the other (right to left, for instance), while regular homepage modules (the ones at the center) can only be moved within their specific column.

...

If you want to display simple modules such as the "Currencies" block in a position for which it was not built, you will have to edit its template files.
More complex module, such as the "Featured" block, can also be made to display be displayed in other sections of the page, but they might have to be partly rewritten in order to have their design work with that new location.

...

Let's install the "Cash on delivery (COD)" module. You first need to access the list of payment modules. It is of course accessible via the "Modules" menupage, in the "Payments and Gateways" category; but you also have a shortcut from within the "Payments" page: just click on the "Click to see the list of payment modules" button to be taken you to the specific part of the "Modules" page where only "Payment & Gateways" modules are displayed.

...

Depending upon the payment, the customer's choice of currency can differ.
You can limit the choice of available payment methods depending on the available currencies: you may want customers to be able to pay with any currency when using PayPal, but those paying Moneybookers should only pay using dollars, for instance.

...

Tip
tileAdding a new currency

By default, only your shop's default currency is available. If you need more, follow this process:

  1. In the "Localization" page under the "Localization" menu, import the localization pack for the country which has the currency in which you are interested. For instance, USA for US Dollars, United Kingdom for UK Pound, etc.
  2. In the "Currencies" page under the "Localization" menu, enabled the currencies you just imported.

If you need to restrict payment module usage according to the user's currency, simply check the boxes that apply and click on the "Save restrictions".

...

Warning

If you change the default currency after having configured some first products, you will have to reset the price of all these products. You should set the default price currency once and for all before adding any product.

...

Here again, just as with currency limitations, the available option options vary depending on the payment module:

  • Buyster: the only option is your own country.
  • Hipay: the only options are the set of countries supported by the service: Austria, Belgium, France, etc.
  • All the others native payment modules should work with all countries.

Find the country you are looking for in the alphabetical list, and check the boxes to select or unselect the payment methods you want to make available to customers from that country. Once all of your settings have been configured, click on the "Save restrictions" button, found at the bottom of the table.
By default, all installed payment methods are enabled for the shop's country.