Magento – How to override Virtual Type class in Magento 2

blocksdependency-injectionmagento2moduleoverrides

How to override VirtualType block in Magento 2, I want to override following virtual type block with my own block,

<virtualType name="Magento\CatalogSearch\Block\SearchResult\ListProduct" type="Magento\Catalog\Block\Product\ListProduct">
   <arguments>
       <argument name="catalogLayer" xsi:type="object">Magento\Catalog\Model\Layer\Search</argument>
   </arguments>
</virtualType>

So I tried to override it from my custom module di.xml like this,

<preference for="Magento\Catalog\Block\Product\ListProduct" type="My\Vendor\Block\Product\ListProductSearch" />

But it does not work.

So, what is the proper way of overriding a virtual type class in Magento 2?

Best Answer

You have to use:

<preference for="Magento\CatalogSearch\Block\SearchResult\ListProduct" type="Vendor\Module\Block\Product\ListProductSearch" />

as Raphael mentioned.

To make this singular block working properly, you need also to add view/frontend/layout/catalogsearch_result_index.xml file with following content:

<?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="search_result_list">
        <action method="setTemplate">
            <argument name="template" xsi:type="string">Magento_Catalog::product/list.phtml</argument>
        </action>
    </referenceBlock>
</body>

Related Solutions

Magento 2 – How to Rewrite TierPrice Block

Suppose package:Learning and module: Custom

Module.xml looks like

<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../../../lib/internal/Magento/Framework/Module/etc/module.xsd">
    <module name="Learning_Custom" setup_version="2.0.0">
        <sequence>
            <module name="Magento_Catalog"/>
        </sequence>
    </module>
</config>

And then create a layout xml following path -> app/code/Learning/Custom/view/frontend/layout/catalog_product_prices.xml

<layout xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../../../../../lib/internal/Magento/Framework/View/Layout/etc/layout_generic.xsd">
    <referenceBlock name="render.product.prices">
        <arguments>
            <argument name="default" xsi:type="array">
                <item name="prices" xsi:type="array">
                    <item name="tier_price" xsi:type="array">
                        <item name="render_template" xsi:type="string">Learning_Custom::product/price/tier_prices.phtml
                    </item>
                </item>
            </argument>
        </arguments>
    </referenceBlock>
</layout>

Create template inside your module or copy base template file inside your module path should be -> app/code/Learning/Custom/view/frontend/templates/product/price/tier_prices.phtml

Magento – Block override in Magento2 not working

So I got something working... I discovered the DI configuration was mapping Magento\Catalog\Block\Product\View to Magento\Catalog\Block\Product\View\Interceptor which is not the generated interceptor I was expecting (Moxune\Moxune\Block\Product\View\Interceptor).

I'm not sure exactly why, but my Magento installation (v2.0.4) does not have a view/frontend/templates/product/view.phtml file, so my guess is the block I was trying to override isn't being used. I did find several other (seemingly more granular) template files and decided to shoot for a block that might correspond to one of those.

That said, I've

Changed my module's di.xml file to

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <preference for="Magento\Catalog\Block\Product\View\Description"
        type="Moxune\Moxune\Block\Product\View\Description" />
</config>

Created the corresponding class

namespace  Moxune\Moxune\Block\Product\View;

use Magento\Framework\View\Element\Template;
use Magento\Catalog\Api\ProductRepositoryInterface;
use Magento\Catalog\Model\Product;

class Description extends \Magento\Catalog\Block\Product\View\Description {
    protected function _toHtml() {   
        $this->setModuleName($this->extractModuleName('Magento\Catalog\Block\Product\View\Description'));
        return parent::_toHtml();
    }   
}

Recompiled the DI configuration

rm -rf var/cache var/di var/generation var/page_cache ; ./bin/magento setup:di:compile

Now I seem to be getting into the _toHtml method of my overridden class!

Best Answer

Related Solutions

Magento 2 – How to Rewrite TierPrice Block

Magento – Block override in Magento2 not working

Related Topic