ecomyseo/prestashop_skills / prestashop-mail-themes
prestashop-mail-themes
VerifiedSkill for creating and extending modern email themes in PrestaShop 8 and 9.
PrestaShop Mail Themes Skill
This skill explains how to use the modern mail engine (introduced in PS 1.7.7) to create custom email designs and apply transformations.
1. Technical Guide
Registering a Mail Theme
Register your module to the actionListMailThemes hook.
public function hookActionListMailThemes(array $params)
{
/** @var \PrestaShop\PrestaShop\Core\MailTemplate\ThemeCollectionInterface $themes */
$themes = $params['mailThemes'];
// Scan your module directory for a theme
$scanner = new \PrestaShop\PrestaShop\Core\MailTemplate\FolderThemeScanner();
$myTheme = $scanner->scan(_PS_MODULE_DIR_ . $this->name . '/mails/themes/my_custom_theme');
if (null !== $myTheme) {
$themes->add($myTheme);
}
}
Adding or Extending Layouts
You can replace core layouts or add new ones.
public function extendLayout(\PrestaShop\PrestaShop\Core\MailTemplate\ThemeCollectionInterface $themes)
{
foreach ($themes as $theme) {
if ($theme->getName() !== 'modern') continue;
$orderConf = $theme->getLayouts()->getLayout('order_conf', ''); // '' means core layout
if ($orderConf) {
$index = $theme->getLayouts()->indexOf($orderConf);
$theme->getLayouts()->offsetSet($index, new \PrestaShop\PrestaShop\Core\MailTemplate\Layout\Layout(
'order_conf',
'@Modules/mymodule/mails/layouts/extended_order_conf.html.twig',
''
));
}
}
}
Mail Transformations
Apply transformations (like changing colors or adding footers) via actionGetMailLayoutTransformations.
public function hookActionGetMailLayoutTransformations(array $params)
{
$transformations = $params['layoutTransformations'];
$transformations->add(new MyColorTransformation('#FF0000'));
}
2. Professional Development Guide
Folder Structure
mails/themes/[theme_name]/: Contains the theme files.mails/layouts/: Contains Twig layouts for emails.mails/subjects/: Subject translations.
Layout Variables
Use actionBuildMailLayoutVariables to add custom variables to email templates.
public function hookActionBuildMailLayoutVariables(array $params)
{
$params['mailLayoutVariables']['my_custom_var'] = 'Dynamic Value';
}
3. User Guide
How to access
- Install the module.
- Go to Design > Mail Theme.
- Select your new theme in the "Choose your mail theme" dropdown and click "Generate emails".
Rules & Best Practices
- Twig only: The modern system uses Twig for design and generates HTML/TXT files.
- Compatibility: Ensure fallback to core themes if your module is disabled.
- Licensing: Always include the Ecom Experts / AFL-3.0 header.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| reverse-engineer-anythingmorluto/reaReverse engineer native, managed, Electron/JavaScript, packaged, firmware, and browser targets with REA, and build agent environments (AgentEnv bundles) of web applications from a live instance or a capture, and of Linux desktop apps with a task from a request. Use shipped-artifact or requested runtime evidence to explain features, compare versions, decompile code, or guide a reconstruction. Skip REA for ordinary source-repository architecture analysis. | Stars: 471k | Updated | Claude CodeCodex | Verified | Install |
| diagnosing-superpowersobra/superpowersUse when a superpowers session went wrong and your human partner wants to know why — repeated work, ignored plans, stumbles, poor results, a skill that didn't fire, "it took too long", "why is it so expensive", "what is it doing" — or wants to build a bug report for the superpowers maintainers, for the current session or a past one identified by id or path, on any harness. | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| dispatching-parallel-agentsobra/superpowersUse when facing 2+ independent tasks that can be worked on without shared state or sequential dependencies | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| executing-plansobra/superpowersUse when executing an implementation plan in the current session as the implementer yourself — your human partner chose inline execution, or no subagent tool is available | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |