{"id":5074,"date":"2024-02-12T17:42:48","date_gmt":"2024-02-12T15:42:48","guid":{"rendered":"https:\/\/www.h-hennes.fr\/blog\/?p=5074"},"modified":"2024-02-13T16:29:52","modified_gmt":"2024-02-13T14:29:52","slug":"prestashop-migrer-les-hooks-deprecies-des-modules","status":"publish","type":"post","link":"https:\/\/www.h-hennes.fr\/blog\/2024\/02\/12\/prestashop-migrer-les-hooks-deprecies-des-modules\/","title":{"rendered":"Prestashop : Migrer les hooks d\u00e9pr\u00e9ci\u00e9s des modules"},"content":{"rendered":"\n<p>Il existe depuis tr\u00e8s longtemps dans le fonctionnement des hooks de prestashop une fonction d&rsquo;alias qui permets de mettre \u00e0 jour le nom d&rsquo;un hook tout en maintenant la compatibilit\u00e9 avec son ancien nom.<br>Le meilleur exemple de cette fonctionnalit\u00e9 est le hook <strong>header<\/strong> qui a \u00e9t\u00e9 remplac\u00e9 par<strong> displayHeader<\/strong> depuis tr\u00e8s longtemps mais qui continue \u00e0 fonctionner.<br>Ceci fonctionnait tr\u00e8s bien et continue d&rsquo;ailleurs de fonctionner, mais depuis la version 8.1 de Prestashop , chaque appel \u00e0 un hook \u00e0 un ancien alias va g\u00e9n\u00e9rer une erreur de log sur le serveur.<br>De ce type :<\/p>\n<p><em>The hook \u00ab\u00a0header\u00a0\u00bb is deprecated, please use \u00ab\u00a0displayHeader\u00a0\u00bb instead in module \u00ab\u00a0moduleName\u00a0\u00bb<\/em><\/p>\n<p>En fonction du nombre de modules concern\u00e9s on peut vite remplir son serveur avec des milliers de lignes inutiles.<br><br>Plusieurs solution pour corriger ce point.<\/p>\n<p><br><strong>Quick &amp; dirty et d\u00e9conseill\u00e9e<\/strong>&nbsp; :&nbsp; Commenter les lignes suivantes dans la m\u00e9thode <strong>exec<\/strong> de la classe <strong>Hook<\/strong> ( via un override )<\/p>\n\n\n\n<pre lang=\"php\">\n\/\/ We throw an error - aliases are deprecated.\n                trigger_error(\n                    sprintf(\n                        'The hook \"%s\" is deprecated, please use \"%s\" instead in module \"%s\".',\n                        $registeredHookName,\n                        $hook_name,\n                        $hookRegistration['module']\n                    ),\n                    E_USER_DEPRECATED\n                );\n<\/pre>\n\n\n\n<p>La 2\u00e8me solution est de corriger les erreurs une par une pour ne plus avoir toutes ces alertes.<br>C&rsquo;est possible de le faire manuellement pour chaque module via l&rsquo;administration et les positions des modules en les supprimant de l&rsquo;ancien hook et en les ajoutant sur le nouveau.<br>En fonction de la volum\u00e9trie cela peut \u00eatre plus ou moins chronophage.<br><br>Pour ma part en tant que d\u00e9veloppeur qui n&rsquo;aime pas faire ce genre de choses manuellement j&rsquo;ai \u00e9crit un script qui le fait de mani\u00e8re automatique \ud83d\ude42 <br>Avant toute chose sachez que ce script ne g\u00e8re pas le multi-boutique et que je d\u00e9cline toute responsabilit\u00e9 sur les effets de bords que cela pourrait avoir sur votre site.<br>Il faut le tester sur un environnement de pr\u00e9production au pr\u00e9alable \ud83d\ude42<\/p>\n\n\n\n<pre lang=\"php\">\nclass PatchDeprecatedHooks\n{\n\n    \/**\n     * Patch des anciens hooks sur les alias pour les mettre sur les nouveaux\n     * @return void\n     *\/\n    public function patch(): void\n    {\n        $affectedHooks = $this->getAffectedModulesAndHooks();\n        if ( count($affectedHooks)){\n            foreach ( $affectedHooks as $affectedHook){\n                try {\n                    $module = \\Module::getInstanceById($affectedHook['id_module']);\n                    $module->unregisterHook($affectedHook['current_hook_name']);\n                    $module->registerHook($affectedHook['new_hook_name']);\n                } catch ( \\Exception $e){\n                    dump('Unable to patch modules hooks for module '\n                        .$affectedHook['name'].' and hook '\n                        .$affectedHook['current_hook_name']\n                        .' '.$e->getMessage()\n                    );\n                }\n            }\n        }\n    }\n\n    \/**\n     * R\u00e9cup\u00e9ration de la liste des hooks d\u00e9pr\u00e9ci\u00e9s\n     *\n     * @return array\n     *\/\n    protected function getAffectedModulesAndHooks(): array\n    {\n        $results = [];\n        try {\n            $deprecatedHooks = \\Db::getInstance()->executeS(\n                \"SELECT hm.id_module,hm.id_hook,hm.id_shop,hm.position,m.`name`, m.version , h.`name` as current_hook_name, a.name new_hook_name\n                    FROM \" ._DB_PREFIX_ . \"hook_module hm\n                    LEFT JOIN \" ._DB_PREFIX_ . \"module m ON m.id_module = hm.id_module\n                    LEFT JOIN \" ._DB_PREFIX_ . \"hook h ON h.id_hook = hm.id_hook\n                    LEFT JOIN \" ._DB_PREFIX_ . \"hook_alias a ON a.`alias` = h.`name`\n                    WHERE hm.id_hook IN (\n                    SELECT id_hook\n                    FROM \" ._DB_PREFIX_ . \"hook_alias a\n                    INNER JOIN \" ._DB_PREFIX_ . \"hook h1 ON h1.name = a.alias\n                    )\n                    ORDER BY hm.id_module\"\n            );\n            if ($deprecatedHooks) {\n                $results = $deprecatedHooks;\n            }\n        } catch ( \\PrestaShopDatabaseException $e){\n            dump('Query error '.$e->getMessage());\n        }\n        return $results;\n    }\n}\n\n<\/pre>\n\n\n\n<p>Plusieurs possibilit\u00e9 pour \u00e9x\u00e9cuter ce code :<\/p>\n<ul>\n<li>Faites une classes sp\u00e9cifique PatchDeprecatedHooks\u00a0 dans un de vos module et appeller la fonction apply depuis n&rsquo;importe quel endroit dans votre module<\/li>\n<li>Mettre toute cette logique dans un fichier d&rsquo;upgrade de module \ud83d\ude42<\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"<p>Il existe depuis tr\u00e8s longtemps dans le fonctionnement des hooks de prestashop une fonction d&rsquo;alias qui permets de mettre \u00e0 jour le nom d&rsquo;un hook tout en maintenant la compatibilit\u00e9 avec son ancien nom.Le meilleur exemple de cette fonctionnalit\u00e9 est le hook header qui a \u00e9t\u00e9 remplac\u00e9 par displayHeader depuis tr\u00e8s longtemps mais qui continue [&hellip;]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"site-sidebar-layout":"default","site-content-layout":"","ast-site-content-layout":"default","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","ast-disable-related-posts":"","theme-transparent-header-meta":"","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"set","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"footnotes":""},"categories":[245],"tags":[604,603,573],"class_list":["post-5074","post","type-post","status-publish","format-standard","hentry","category-prestashop-2","tag-hook","tag-logs","tag-prestashoo","prestashop-8-1"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.h-hennes.fr\/blog\/wp-json\/wp\/v2\/posts\/5074","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.h-hennes.fr\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.h-hennes.fr\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.h-hennes.fr\/blog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/www.h-hennes.fr\/blog\/wp-json\/wp\/v2\/comments?post=5074"}],"version-history":[{"count":3,"href":"https:\/\/www.h-hennes.fr\/blog\/wp-json\/wp\/v2\/posts\/5074\/revisions"}],"predecessor-version":[{"id":5084,"href":"https:\/\/www.h-hennes.fr\/blog\/wp-json\/wp\/v2\/posts\/5074\/revisions\/5084"}],"wp:attachment":[{"href":"https:\/\/www.h-hennes.fr\/blog\/wp-json\/wp\/v2\/media?parent=5074"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.h-hennes.fr\/blog\/wp-json\/wp\/v2\/categories?post=5074"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.h-hennes.fr\/blog\/wp-json\/wp\/v2\/tags?post=5074"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}