Notice: You are browsing the documentation for PrestaShop 9, which is currently in development.
You might want to read the documentation for the current version, PrestaShop 8. Read the current version of this page
The theme’s theme.yml file defines all of the theme’s configuration and meta information, such as its version number, layouts, compatibility range, hook configuration, etc.
The theme’s name MUST match its directory name. For instance, if the theme is named “My Awesome Theme” and its ’name’ value is set to “my-awesome-theme”, then the folder MUST be /my-awesome-theme .
Users will be able to choose the layout for each page from the theme’s settings page. Layouts are automatically parsed from the theme’s /templates/layouts folder, so this configuration key is optional, but it allows designers to provide some more user-friendly info than just a filename.
name: mysupertheme # The name must match the directory name
display_name: My Super Theme
version: 1.0.0
author:
name: "John Doe"
email: "[email protected]"
url: "https://www.prestashop-project.org"
meta:
compatibility:
from: 8.0
to: ~
available_layouts:
layout-full-width:
name: Full width layout
description: Ideal for product pages to maximize picture size
layout-left-side-column:
name: One small left column
description: Great for CMS pages to show advertisements on the side
To set the parent theme, set the parent key to the theme’s name:
parent: classic
Starting from
8.0
, the setting use_parent_assets is now fully working and correctly loads assets from the parent theme.
assets:
use_parent_assets: true
When set to true, some additional variables are changed for Smarty templates.
theme_assets is replaced with the parent theme assets URI,img_url, css_url, js_url are replaced with the parent theme corresponding URIs,some other variables are available:
child_theme_assets which is the child theme assets URI,child_img_url, child_css_url, child_js_url which are the child theme corresponding URIs.When set to false, only theme_assets, img_url, css_url and js_url are available, and are the child theme corresponding URIs.
To maintain the behavior of 1.7
and load the child theme’s assets, use_parent_assets must be set to false.
You can have the theme change the configuration of PrestaShop when the theme is enabled.
global_settings:
configuration:
PS_QUICK_VIEW: false
NEW_PRODUCTS_NBR: 4
PS_PNG_QUALITY: 8
You can also add custom configuration variables here (to use on modules/themes).
You can have the theme enable, disable or reset modules when the theme is enabled.
global_settings:
modules:
to_enable:
# All modules below are enabled when
# the theme is enabled (and installed if needed).
# They are disabled when the theme is disabled.
- my-custom-module
- yippeeslider
to_disable:
# All modules below are disabled when the theme is enabled.
# They are re-enabled when the theme is disabled.
- homeslider
- blockwishlist
to_reset:
# All modules below are reset when the theme is enabled.
- blockreassurance
- blockwishlist
You can also have the theme create hooks and attach modules to custom and existing hooks when the theme is enabled.
global_settings:
hooks:
custom_hooks:
- name: displayFooterBefore
title: displayFooterBefore
description: Add a widget area above the footer
modules_to_hook:
displayHeaderTop:
# displayHeaderTop will have exactly the following
# modules hooked to it, in the specified order.
# Each module in this list will be unhooked
# from all other display hooks it is hooked to.
- blocklanguages
- blockcurrencies
- blockuserinfo
displayHeaderMiddle:
# displayHeaderMiddle will have whatever is currently hooked to it
# kept hooked to it, and blocksearch will be appended
# to the list (or moved to the end if already hooked there).
- ~
- blocksearch
displayHeaderBottom:
# displayHeaderBottom will have blocktopmenu and blockcart
# prepended to it.
- blocktopmenu
- blockcart
- ~
displayFooter:
- blocknewsletter
displayLeftColumn:
# blockcategories is hooked on all pages on displayLeftColumn
- blockcategories
# blocktags is hooked on displayLeftColumn on all pages
# except "category" and "index"
- blocktags:
except_pages:
- category
- index
Enabling the theme will remove all the existing image types.
Therefore, themes MUST declare their image types, and what they apply to.
global_settings:
image_types:
cart_default:
width: 80
height: 80
scope: [products]
small_default:
width: 125
height: 125
scope: [products, categories, manufacturers, suppliers]
medium_default:
width: 300
height: 300
scope: [products, categories, manufacturers, suppliers]
large_default:
width: 500
height: 500
scope: [products]
home_default:
width: 250
height: 250
scope: [products]
category_default:
width: 960
height: 350
scope: [categories]
product_listing:
width: 220
height: 220
scope: [products, categories, manufacturers, suppliers]
large_banner:
width: 960
height: 400
scope: [categories]
All the settings below can be changed through an interface in the theme’s back office interface, and only depend on the theme/shop combination.
When the theme.yml file is parsed by PrestaShop, the ’theme_settings’ configuration key is copied to a file named settings_n.yml, where ’n’ is the id of the shop where the theme is installed (settings_123456.yml, for instance).
When the configuration is changed through the back office interface, only the settings_n.yml file is updated - the theme.yml file remains unchanged.
global_settings:
theme_settings:
default_layout: layout-full-width
layouts:
# Specific layout for some pages
identity: layout-left-side-column
order-confirmation: layout-left-side-column
core.js file in your custom theme
8.1.0
You can disable core.js loading and provide a custom implementation of the whole logic initially contained in core.js.
To do this, use the core_scripts option, set to false, in theme_settings like in this example:
theme_settings:
core_scripts: false
When making a theme you may want to add features with custom modules. It’s important that these modules are installed with your theme. These modules should be declared as dependencies so you’re sure prestashop will export them when creating your theme zipball.
So far themes only have modules dependencies.
dependencies:
modules:
- xx_customslider
- xx_customproductpage