Custom theme doesn't apply XML layout updates when applied to a product #7710

chickenland · 2016-12-07T08:29:45Z

I was looking to open this issue, but thought I'd try and find one before I did. I think this issue is linked to #7503, but is manifesting is achieved in a different way

We have a theme that does not inherit, and it's XML updates appear to be ignored.

Preconditions

Magento 2.1.2, PHP 5.6.24
Environment: Windows XAMPP / Windows WSL
Developer Mode

Steps to reproduce

Set the theme for a specific storeview to Purenet/Theme (our default theme for the store) via Content > Design > Configuration > Edit.

Create and install a theme that has no inheritence. Add layout changes. For this example, I created a theme with a catalog_product_view.xml file that removes the main title for the product as Purenet/Client.

<?xml version="1.0"?>
<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
<body>
    <referenceBlock name="page.main.title" remove="true"/>
</body>
</page>

Deploy static content for the 'Purenet Client' theme:
bin/magento setup:static:deploy --theme="Purenet/Client" en_GB
Apply the 'Purenet Client' theme to a category via Products > Catalog > Actual Product > Schedule Design Update > Set Dates & New theme to be Purenet/Client. Save Product.

Expected result

When checking the the product page, you should not see the main product title.

Actual result

On the Product Page, the main product title is displayed.

Setting a similar XML layout file on a category in the same manner appears to work.

Investigation

So far, it looks like _fetchPackageLayoutUpdates within lib/internal/Magento/Framework/View/Model/Layout/Merge.php doesn't capture the XML that contains the handle updates. I found moving the XML into catalog_product_prices made it added as an update, however, it was still not removed.

The text was updated successfully, but these errors were encountered:

shavounet · 2017-01-06T10:48:18Z

I can confirm this bug : the new Theme is correctly set by \Magento\Catalog\Helper\Product\View::initProductLayout ; yet, only templates are changed and layout XML updates are ignored...

shavounet · 2017-01-06T10:57:20Z

Also, I didn't manage to use my theme in the "Schedule a design update" in product form (outside of any category configuration...)

shavounet · 2017-01-06T11:23:38Z

I saw the line "Custom themes now inherit parent XML configuration information as expected." in Magento's 2.1.3 release notes, but after upgrading to 2.1.3 and cleaning every cache, it's still not working.

shavounet · 2017-01-06T16:50:27Z

I may have fixed it in my codebase... I used a before plugin on the execute method of catalog/product/view controller. The idea is to set the code bellow as soon as possible (from \Magento\Catalog\Helper\Product\View::initProductLayout).

            $settings = $this->_catalogDesign->getDesignSettings($product);

            if ($settings->getCustomDesign()) {
                $this->_catalogDesign->applyCustomDesign($settings->getCustomDesign());
            }

The bug is due to the layout being loaded before the custom design is set. It happens twice :

vendor/magento/module-catalog/Controller/Product/View.php:108 (with the 'addDefaultHandle')
vendor/magento/module-catalog/Helper/Product/View.php:195 (with the 'getUpdate')

bunsworth94 · 2017-01-11T11:40:19Z

@shavounet I've tried your solution however it doesn't seem to work? Could you expand on this more please?

shavounet · 2017-01-19T11:00:38Z

Here is the main code of the plugin I use, on Magento\Catalog\Controller\Product\View :

    /**
     * Custom fix for https://github.com/magento/magento2/issues/7710
     * It allows to use a custom them for product page
     * @see \Magento\Catalog\Controller\Product\View::execute
     * @param View $subject
     */
    public function beforeExecute(View $subject)
    {
        $productId = (int) $subject->getRequest()->getParam('id');
        $categoryId = (int) $subject->getRequest()->getParam('category', false);

        $product = $this->initProduct($productId, $categoryId);
        if($product) {
            $settings = $this->_catalogDesign->getDesignSettings($product);

            if ($settings->getCustomDesign()) {
                $this->_catalogDesign->applyCustomDesign($settings->getCustomDesign());
            }
        }
    }

    /**
     * Get the product with the given ID, and optionally set the category, if given
     * @param $productId
     * @param $categoryId
     * @return \Magento\Catalog\Model\Product|ProductInterface|bool
     */
    protected function initProduct($productId, $categoryId)
    {

        try {
            $product = $this->productRepository->getById($productId, false, $this->storeManager->getStore()->getId());
        } catch (NoSuchEntityException $e) {
            return false;
        }

        try {
            $category = $this->categoryRepository->get($categoryId);
            $product->setCategory($category);
        } catch (NoSuchEntityException $e) {
            // Do nothing
        }

        return $product;
    }

dknzdesign · 2017-04-23T06:56:03Z

I have this problem to. I've been stuck on it for 4 days! Thank so much for the solution. Initially I thought I had made a mistake in the theme layout but no matter what I did to the xml file, it would not render.
Magento 2 seems like its still buggy even after 2.1 has been released.

eoss-th · 2017-05-04T10:51:51Z

So i would like to know that this bug will close in 2.1.7 or not?

surendragamage · 2017-06-06T05:58:03Z

Go to your database. select theme table. Check custom theme record. If the value of the type field is 1 change it to 0. This fixed my issue.

veloraven · 2017-06-12T13:05:30Z

Internal ticket was created for this issue: MAGETWO-69709

worldserved · 2017-07-20T13:15:56Z

hi shavounet, i have been struggling with this. i cannot figure out how to implement your fix to try it out. i have a child theme (myfirsttheme) with Magento/blank as parent.
I have another child theme (mysecondtheme) with (myfirsttheme) as parent.
The problem is template files amended get parsed in frontend but the xml files do not. i am only seeking to amend the catalog_product_view.xml and it does not parse at all, overriden by settings in the (myfirsttheme)
i think your fix will be a solution for me but i do not know how to implement them. copied and pasted in code at Magento\Module_Catalog\Controller\Product\View.php it didnt work. and tried it in Magento\Module_Catalog\Helper\Product\View.php that also didnt work either. Please can you tell me if that solution fixes my detailed problem and how i should implement it.
Thank you

dknzdesign · 2017-07-20T13:21:54Z

@elghana I have a module that you can add to your site that solves this problem using the solution above.
email me for details: info@dknzdesign.com

DenisNatalevich · 2017-08-30T14:28:13Z

My solution:

Override\Override\etc\di.xml

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
    <preference for="Magento\Catalog\Helper\Product\View" type="Override\Override\Model\View"/>
</config>

Override\Override\Model\View.php

<?php
namespace Override\Override\Model;

use Magento\Framework\View\Result\Page as ResultPage;

class View extends \Magento\Catalog\Helper\Product\View
{

    public function __construct(
        \Magento\Framework\App\Helper\Context $context,
        \Magento\Catalog\Model\Session $catalogSession,
        \Magento\Catalog\Model\Design $catalogDesign,
        \Magento\Catalog\Helper\Product $catalogProduct,
        \Magento\Framework\Registry $coreRegistry,
        \Magento\Framework\Message\ManagerInterface $messageManager,
        \Magento\CatalogUrlRewrite\Model\CategoryUrlPathGenerator $categoryUrlPathGenerator,
        array $messageGroups = []
    ) {
        parent::__construct(
            $context,
            $catalogSession,
            $catalogDesign,
            $catalogProduct,
            $coreRegistry,
            $messageManager,
            $categoryUrlPathGenerator
        );
    }

    public function initProductLayout(ResultPage $resultPage, $product, $params = null)
    {
        $settings = $this->_catalogDesign->getDesignSettings($product);
        $pageConfig = $resultPage->getConfig();

        if ($settings->getCustomDesign()) {
            $this->_catalogDesign->applyCustomDesign($settings->getCustomDesign());
        }

        // Apply custom page layout
        if ($settings->getPageLayout()) {
            $pageConfig->setPageLayout($settings->getPageLayout());
        }

        $urlSafeSku = rawurlencode($product->getSku());

        // Load default page handles and page configurations
        if ($params && $params->getBeforeHandles()) {
            foreach ($params->getBeforeHandles() as $handle) {
                $resultPage->addPageLayoutHandles(
                    ['id' => $product->getId(), 'sku' => $urlSafeSku, 'type' => $product->getTypeId()],
                    $handle
                );
            }
        }

        $resultPage->addPageLayoutHandles(
            ['id' => $product->getId(), 'sku' => $urlSafeSku, 'type' => $product->getTypeId()]
        );

        if ($params && $params->getAfterHandles()) {
            foreach ($params->getAfterHandles() as $handle) {
                $resultPage->addPageLayoutHandles(
                    ['id' => $product->getId(), 'sku' => $urlSafeSku, 'type' => $product->getTypeId()],
                    $handle
                );
            }
        }

        // Apply custom layout update once layout is loaded
        $update = $resultPage->getLayout()->getUpdate();
        $layoutUpdates = $settings->getLayoutUpdates();

        // NEW CODE
        $category_ids = $product->getData('category_ids');
        if (is_array($category_ids) && count($category_ids)) {
            foreach($category_ids as $category_id) {
                $objectManager = \Magento\Framework\App\ObjectManager::getInstance();
                $model = $objectManager->create('Magento\Catalog\Api\CategoryRepositoryInterface');
                $category = $model->get($category_id);
                if($category->getData('custom_apply_to_products')) {
                    $layoutUpdates[] = $category->getData('custom_layout_update');
                }
            }
        }

        if ($layoutUpdates) {
            if (is_array($layoutUpdates)) {
                foreach ($layoutUpdates as $layoutUpdate) {
                    $update->addUpdate($layoutUpdate);
                }
            }
        }

        $currentCategory = $this->_coreRegistry->registry('current_category');
        $controllerClass = $this->_request->getFullActionName();
        if ($controllerClass != 'catalog-product-view') {
            $pageConfig->addBodyClass('catalog-product-view');
        }
        $pageConfig->addBodyClass('product-' . $product->getUrlKey());
        if ($currentCategory instanceof \Magento\Catalog\Model\Category) {
            $pageConfig->addBodyClass('categorypath-' . $this->categoryUrlPathGenerator->getUrlPath($currentCategory))
                ->addBodyClass('category-' . $currentCategory->getUrlKey());
        }

        return $this;
    }
}

magento-engcom-team · 2017-10-19T13:30:40Z

@chickenland, thank you for your report.
We've created internal ticket(s) MAGETWO-69709 to track progress on the issue.

kirmorozov · 2018-02-07T16:04:26Z

Same as #8333

kirmorozov · 2018-02-07T16:07:33Z

I provided reference fast patch within #8333

magento-engcom-team · 2018-12-21T23:40:21Z

Hi @chickenland. Thank you for your report.
The issue has been fixed in #19124 by @drew7721 in 2.3-develop branch
Related commit(s):

The fix will be available with the upcoming 2.3.1 release.

uabassguy · 2019-08-21T02:37:14Z

@magento-engcom-team The issue still exists in 2.3.2, updating the type field in the theme table to 0 fixed it in my case, need a more substantial fix. Half of those commits referenced are just comments

#7710 (comment)

BtotheT · 2020-03-31T20:21:45Z

@shavounet thank you for providing the plugin code you used - that was the ONLY one that worked for a Cloud 2.3.3 instance!

L3 bugfix delivery

veloraven added 2.1.x bug report Area: Frontend labels Dec 19, 2016

KrystynaKabannyk assigned tkacheva Feb 2, 2017

veloraven added the Issue: Ready for Work Gate 4. Acknowledged. Issue is added to backlog and ready for development label Jun 12, 2017

magento-engcom-team added 2.1.x Issue: Ready for Work Gate 4. Acknowledged. Issue is added to backlog and ready for development bug report Area: Frontend Issue: Format is valid Gate 1 Passed. Automatic verification of issue format passed labels Sep 11, 2017

okorshenko unassigned tkacheva Dec 1, 2017

magento-engcom-team removed 2.1.x labels Dec 14, 2017

kirmorozov mentioned this issue Feb 18, 2018

#8333: Use Design to get theme, because theme is changed after constr… #13713

Closed

4 tasks

drew7721 mentioned this issue Jun 12, 2018

User agent exception not setting the correct templates for product pages. #16074

Closed

drew7721 mentioned this issue Nov 9, 2018

bug-fix #16074 - Fix theme change in middle of product page. #19124

Merged

4 tasks

magento-engcom-team added the Fixed in 2.3.x The issue has been fixed in 2.3 release line label Dec 21, 2018

magento-engcom-team closed this as completed Dec 21, 2018

Prunecreation mentioned this issue Jul 6, 2020

Magento v2.3 - Choosing a child theme for product .. layout xml doesn't work nor does the layout update #26295

Open

magento-devops-reposync-svc pushed a commit that referenced this issue Aug 10, 2022

Merge pull request #7710 from magento-l3/PR_07_JUN_2022_Odubovyk

bd715ae

L3 bugfix delivery

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Custom theme doesn't apply XML layout updates when applied to a product #7710

Custom theme doesn't apply XML layout updates when applied to a product #7710

chickenland commented Dec 7, 2016

shavounet commented Jan 6, 2017

shavounet commented Jan 6, 2017

shavounet commented Jan 6, 2017

shavounet commented Jan 6, 2017

bunsworth94 commented Jan 11, 2017

shavounet commented Jan 19, 2017

dknzdesign commented Apr 23, 2017

eoss-th commented May 4, 2017

surendragamage commented Jun 6, 2017

veloraven commented Jun 12, 2017

worldserved commented Jul 20, 2017

dknzdesign commented Jul 20, 2017

DenisNatalevich commented Aug 30, 2017

magento-engcom-team commented Oct 19, 2017

kirmorozov commented Feb 7, 2018

kirmorozov commented Feb 7, 2018

magento-engcom-team commented Dec 21, 2018

uabassguy commented Aug 21, 2019 •

edited

Loading

BtotheT commented Mar 31, 2020

Custom theme doesn't apply XML layout updates when applied to a product #7710

Custom theme doesn't apply XML layout updates when applied to a product #7710

Comments

chickenland commented Dec 7, 2016

Preconditions

Steps to reproduce

Expected result

Actual result

Investigation

shavounet commented Jan 6, 2017

shavounet commented Jan 6, 2017

shavounet commented Jan 6, 2017

shavounet commented Jan 6, 2017

bunsworth94 commented Jan 11, 2017

shavounet commented Jan 19, 2017

dknzdesign commented Apr 23, 2017

eoss-th commented May 4, 2017

surendragamage commented Jun 6, 2017

veloraven commented Jun 12, 2017

worldserved commented Jul 20, 2017

dknzdesign commented Jul 20, 2017

DenisNatalevich commented Aug 30, 2017

magento-engcom-team commented Oct 19, 2017

kirmorozov commented Feb 7, 2018

kirmorozov commented Feb 7, 2018

magento-engcom-team commented Dec 21, 2018

uabassguy commented Aug 21, 2019 • edited Loading

BtotheT commented Mar 31, 2020

uabassguy commented Aug 21, 2019 •

edited

Loading