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
We advise theme developers to compile most of their style and JavaScript code into a single concatenated/minified file (see the Webpack section below).
If you need to add special assets, for example an extra JavaScript library on the home page or the product page, there are a few ways to do so.
Your theme have to print assets correctly in the smarty template, and it’s explained in the template section.
In PrestaShop 1.7+, it’s easy to register custom assets on each page. The major improvement is that you can easily manage them from your theme, without any modules.
We introduced new methods to register assets, and especially new cool options.
For instance, you can register your asset specifically in the head or bottom of your HTML code; you can load it with attributes like async or defer; and you can even inline it easily.
One favorite option is the priority one, which makes it very easy to ensure everything is loaded in the order you need.
addJS(), addCSS(), addJqueryUI() and addJqueryPlugin() methods. Incidentally, now is the best time to update your libraries and use the new method.Here is a list of options, and what they do.
PrestaShop’s FrontController class provides 2 new methods to easily register new assets: registerStylesheet() and registerJavascript().
In order to have the most extensible signatures, these 2 methods take 3 arguments. The first one is the unique ID of the asset, the second one is the relative path, and the third one is an array of all other optional parameters, as described below.
ID
This unique identifier needed for each asset. Reusing the same ID is useful to either override or unregister something already loaded by the Core or a native module.
However, avoid generic names when adding new JS and CSS files to avoid collision with other extensions. Prefixing with your module or theme name is a good start.
Relative path
This is the path of your asset. In order to make your assets fully overridable and compatible with the parent/child feature, you need to provide the path from the theme’s root directory, or PrestaShop’s root directory if it’s a module.
For example:
Extra parameters for stylesheet registration
| Name | Values | Comment |
| media | all | braille | embossed | handheld | print | projection | screen | speech | tty | tv (default: all) | - |
| priority | 0-999 (default: 50) | 0 is the highest priority |
| inline | true | false (default: false) | If true, your style will be printed inside the <style> tag in your HTML <head>. Use with caution. |
| version | version number (default: null) | You can provide the version number, which will be added as a query string to the asset's URL |
| needRtl | true | false (default: false) | If true, the rtl version of the stylesheet will be loaded |
Extra parameters for JavaScript registration
| Name | Values | Comment |
| position | head | bottom (default: bottom) | JavaScript files should be loaded in the bottom as much as possible. Remember: core.js is loaded as a first thing in the bottom so jQuery won't be loaded in the <head> part. |
| priority | 0-999 (default: 50) | 0 is the highest priority |
| inline | true | false (default: false) | If true, your JavaScript will be printed inside <script type="text/javascript"> tags inside your HTML. Use with caution. |
| attributes | async | defer | none (default: none) | Load JavaScript file with the corresponding attribute (Read more: Async vs Defer attributes) |
| server | local | remote (default: local) | Define if the JS resource is a local or remote path |
| version | version number (default: null) | You can provide the version number, which will be added as a query string to the asset's URL |
Every page of every theme loads the following files:
| Filename | ID | Priority | Comment |
| theme.css | theme-main | 50 | Most (all?) of your theme's styles. Should be minified. |
| rtl.css | theme-rtl | 900 | Loaded only for Right-To-Left language |
| custom.css | theme-custom | 1000 | Empty file loaded at the very end to allow user to override some simple style. |
| core.js | corejs | 0 | Provided by PrestaShop. Contains jQuery3, dispatches PrestaShop events and holds PrestaShop logic. |
| theme.js | theme-main | 50 |
|
| custom.js | theme-custom | 1000 | Empty file loaded at the very end, to allow users to use their own custom JavaScript without modifying core files. |
By now you probably understood that this theme.yml file became the heart of PrestaShop themes.
To register assets, create a new assets key at the top level of your theme.yml, and register your files according to your needs. Page identifiers are based on the php_self property of each controller (example)
For example, if you want to add an external library on each page and a custom library on the Product page:
assets:
css:
product:
- id: product-extra-style
path: assets/css/product.css
media: all
priority: 100
js:
all:
- id: this-cool-lib
path: assets/js/external-lib.js
priority: 30
position: bottom
product:
- id: product-custom-lib
path: assets/js/product.js
priority: 200
attribute: async
In addition, if you want to include a library hosted in a different server you can use the following syntax:
assets:
css:
all:
- id: custom-cdn-css
path: //cdn-url.com/external-lib.css
media: all
priority: 200
server: remote
js:
all:
- id: custom-cdn-js
path: //cdn-url.com/external-lib.js
priority: 200
server: remote
When developing a PrestaShop module, you may want to add specific styles for your templates. The best way is to use the registerStylesheet and registerJavascript methods provided by the parent FrontController class.
theme.js and theme.css).If you develop a front controller, simply extend the setMedia() method. For instance:
public function setMedia()
{
parent::setMedia();
if ('product' === $this->php_self) {
$this->registerStylesheet(
'module-modulename-style',
'modules/'.$this->module->name.'/css/modulename.css',
[
'media' => 'all',
'priority' => 200,
'version' => 'release-2021-11'
]
);
$this->registerJavascript(
'module-modulename-simple-lib',
'modules/'.$this->module->name.'/js/lib/simple-lib.js',
[
'priority' => 200,
'attributes' => 'async',
'version' => 'release-2021-11'
]
);
}
}
If you only have your module’s class, register your code on the actionFrontControllerSetMedia hook, and add your asset on the go inside the hook:
public function hookActionFrontControllerSetMedia($params)
{
// Only on the product page
// You could also check if the current controller is an instance of the one you want to target
if ('product' instanceof $this->context->controller->php_self) {
$this->context->controller->registerStylesheet(
'module-'.$this->name.'-style',
'modules/'.$this->name.'/css/modulename.css',
[
'media' => 'all',
'priority' => 200,
]
);
$this->context->controller->registerJavascript(
'module-'.$this->name.'-simple-lib',
'modules/'.$this->name.'/js/lib/simple-lib.js',
[
'priority' => 200,
'attributes' => 'async',
]
);
}
// On every page
$this->context->controller->registerJavascript(
'module-'.$this->name.'-js',
'modules/'.$this->name.'/ga.js',
[
'position' => 'head',
'inline' => true,
'priority' => 10,
'version' => 'release-2021-10'
]
);
}
You can unregister assets! That’s the whole point of an id. For example if you want to improve your theme/module’s compatibility with a module, you can unregister its assets and handle them yourself.
Let’s say you want to be fully compatible with a popular navigation module. You could create a template override of course, but you could also remove the style that comes with it and bundle your specific style in your theme.css (since it’s loaded on every page).
To unregister an assets, you need to know its ID.
As of today, the only way to unregister an asset without any module is to place an empty file where the module override would be.
If the module registers a JavaScript file placed in views/js/file.js, you simply need to create an empty file in modules/modulename/views/js/file.js.
It works for both JavaScript and CSS assets.
Both unregisterJavascript and unregisterStylesheet methods take only one argument: the unique ID of the resource you want to remove.
<?php
// In a front controller
public function setMedia()
{
parent::setMedia();
$this->unregisterJavascript('the-identifier');
}
// In a module class
public function hookActionFrontControllerSetMedia($params)
{
$this->context->controller->unregisterJavascript('the-identifier');
}