Magento CE 1.7.0.2 – Override price.phtml Template Using addPriceBlockType

ce-1.7.0.2layoutpricetemplatexml

I'm writing a custom extension and trying to override the price.phtml template (catalog/product/price.phtml) with my own but I cannot get it to work.

The documentation and examples I have seen suggest I should use the addPriceBlockType method in the layout update xml file as shown below. However, this doesn't work and it is driving me mad.

Other layout updates work so I know the layout xml file is being called correctly from the module's config.xml.

One thing – I think in older versions of Magento there was different product price template files for each of the product types but this is no longer the case in 1.7? Could that mean that addPriceBlockType will no longer work and I need to use some other method?

Any help would be much appreciated.

Thanks!
Chris

<?xml version="1.0"?>
<layout version="0.1.0">
    <default>
        <reference name="catalog_product_price_template">
            <action method="addPriceBlockType"><type>simple</type><block>catalog/product_price</block><template>hideprice/price.phtml</template></action>
            <action method="addPriceBlockType"><type>grouped</type><block>catalog/product_price</block><template>hideprice/price.phtml</template></action>
            <action method="addPriceBlockType"><type>configurable</type><block>catalog/product_price</block><template>hideprice/price.phtml</template></action>
            <action method="addPriceBlockType"><type>virtual</type><block>catalog/product_price</block><template>hideprice/price.phtml</template></action>
            <action method="addPriceBlockType"><type>bundled</type><block>catalog/product_price</block><template>hideprice/price.phtml</template></action>
        </reference>
    </default>

...

Update: Thanks to Marius below for shedding some light on this. I have now found another approach which to me is much cleaner than messing round with the insanely complicated xml layouts.

In my module I have extended Mage_Catalog_Block_Product_Price and added a call to

$this->setTemplate('hideprice/price.phtml')

in the _toHtml() function. This single change ensures that my new price.phtml template is used everywhere.

Best Answer

Your reference is name is wrong.
Also the reference name depends on the page you are viewing.
Here is how your layout file should look.

<?xml version="1.0"?>
<layout>
    <catalog_category_default>
        <reference name="product_list">
            <!-- your addPriceBlockType methods here-->
        </reference>
    </catalog_category_default>

    <catalog_category_view>
        <reference name="product_list">
            <!-- your addPriceBlockType methods here-->
        </reference>
    </catalog_category_view>

    <catalog_category_layered>
        <reference name="product_list">
            <!-- your addPriceBlockType methods here-->
        </reference>
    </catalog_category_layered>

    <catalog_product_compare_index>
        <reference name="catalog.compare.list">
            <!-- your addPriceBlockType methods here-->
        </reference>
    </catalog_product_compare_index>

    <catalogsearch_result_index>
        <reference name="search_result_list">
            <!-- your addPriceBlockType methods here-->
        </reference>
    </catalogsearch_result_index>

    <catalogsearch_advanced_result>
        <reference name="search_result_list">
            <!-- your addPriceBlockType methods here-->
        </reference>
    </catalogsearch_advanced_result>

    <tag_product_list>
        <reference name="search_result_list">
            <!-- your addPriceBlockType methods here-->
        </reference>
    </tag_product_list>

    <tag_customer_view>
        <reference name="customer_view">
            <!-- your addPriceBlockType methods here-->
        </reference>
    </tag_customer_view>

    <default>
        <reference name="cart_sidebar">
            <!-- your addPriceBlockType methods here-->
        </reference>
        <reference name="wishlist_sidebar">
            <!-- your addPriceBlockType methods here-->
        </reference>
        <reference name="catalog_product_price_template">
            <!-- your addPriceBlockType methods here-->
        </reference>
    </default>

    <catalog_product_view>
        <reference name="catalog.product.related">
            <!-- your addPriceBlockType methods here-->
        </reference>
    </catalog_product_view>
    <PRODUCT_TYPE_simple>
        <reference name="product.info.upsell">
             <!-- your addPriceBlockType methods here-->
        </reference>
    </PRODUCT_TYPE_simple>
    <checkout_cart_index>
        <reference name="checkout.cart.crosssell">
            <!-- your addPriceBlockType methods here-->
        </reference>
    </checkout_cart_index>
    <PRODUCT_TYPE_bundle translate="label" module="bundle">
        <reference name="product.info.bundle"> 
            <!-- your addPriceBlockType only for bundle here-->
        </reference>
        <reference name="product.clone_prices">
            <!-- your addPriceBlockType only for bundle here-->
        </reference>
    </PRODUCT_TYPE_bundle>
    <rss_catalog_category>
        <reference name="rss.catalog.category">
            <!-- your addPriceBlockType methods here-->
        </reference>
    </rss_catalog_category>
    <rss_catalog_new>
        <reference name="rss.catalog.new">
            <!-- your addPriceBlockType methods here-->
        </reference>
    </rss_catalog_new>
    <rss_catalog_tag>
        <reference name="rss.catalog.tag">
            <!-- your addPriceBlockType methods here-->
        </reference>
    </rss_catalog_tag>
</layout>

I hope I've covered all the cases. Good luck.

Related Solutions

Magento – using local.xml to avoid repetition

Yes, you seem to have misunderstood the syntax involved in what you want to do (though it seems you've understood the principles, and that's half the battle!).

Don't use an output block with a typical Magento layout, as the root block is already set as an (the) output block (ref. page.xml):
```
<block type="page/html_head" name="head" output="toHtml"> 
```

You should not be redeclaring the head block; rather, you should reference the one already created (again, ref page.xml):

<!-- <block type="page/html_head" name="head" output="toHtml"> This replaces the original! -->
<reference name="head">
    <action method="addCss"><stylesheet>css/normalize.css</stylesheet></action>
</reference>

Collect would-be-repeated directives in a custom layout update handle and use the <update> directive to include them in other handles:

<UTILITY_HANDLE>
    <reference name="head">
        <action method="addCss"><stylesheet>css/normalize.css</stylesheet></action>
    </reference>
    <reference name="content">
        <block type="core/template" name="prefcentre_regform" template="ps/prefcentre/signup.phtml" />
    </reference>
</UTILITY_HANDLE>
<!-- include the above on catalog product view page -->
<catalog_product_view>
    <update handle="UTILITY_HANDLE" />
</catalog_product_view>

Magento – Price Template addPriceBlockType on Related and Upsell Items

This is my wild guess. Not sure whether it works or not. However it feels logical to me. First of all you are using addPriceBlockType() function, which is defined in Mage_Catalog_Block_Product_Abstract block class. Let us look what this method does.

public function addPriceBlockType($type, $block = '', $template = '')
    {
        if ($type) {
            $this->_priceBlockTypes[$type] = array(
                'block' => $block,
                'template' => $template
            );
        }
}

This method simply set _priceBlockTypes property with the given details. In our case, this property holds a values like this.

Mage_Catalog_Block_Product_Abstract::$_priceBlockTypes = array(
    'simple' => array(
        'block' => 'catalog/product_price',
        'template' => 'catalog/product/reseller/price.phtml'
    )
);

Layout job is over. Value is set correctly in Mage_Catalog_Block_Product_Abstract::$_priceBlockTypes. Now we need to see how price template get rendering in frontend. For this take a look on list.phtml. You can see a code like this.

<?php echo $this->getPriceHtml($_product, true) ?>

In related.phtml, this block is invoked like this.

<?php echo $this->getPriceHtml($_item, true, '-related') ?>

Now it is important to know what getPriceHtml() does. Again this is a property of Mage_Catalog_Block_Product_Abstract block class. Let us have a look.

public function getPriceHtml($product, $displayMinimalPrice = false, $idSuffix = '')
{
    $type_id = $product->getTypeId();
    if (Mage::helper('catalog')->canApplyMsrp($product)) {
        $realPriceHtml = $this->_preparePriceRenderer($type_id)
            ->setProduct($product)
            ->setDisplayMinimalPrice($displayMinimalPrice)
            ->setIdSuffix($idSuffix)
            ->toHtml();
        $product->setAddToCartUrl($this->getAddToCartUrl($product));
        $product->setRealPriceHtml($realPriceHtml);
        $type_id = $this->_mapRenderer;
    }

    return $this->_preparePriceRenderer($type_id)
        ->setProduct($product)
        ->setDisplayMinimalPrice($displayMinimalPrice)
        ->setIdSuffix($idSuffix)
        ->toHtml();
}

A close look reveals that, the method first retrieves product's type id and then use that value to prepare price section. ie

$type_id = $product->getTypeId();
.....
return $this->_preparePriceRenderer($type_id);

Now let us have a look what this protected _preparePriceRenderer() method does.

public function _preparePriceRenderer($productType)
{
    return $this->_getPriceBlock($productType)
        ->setTemplate($this->_getPriceBlockTemplate($productType))
        ->setUseLinkForAsLowAs($this->_useLinkForAsLowAs);
}

This method gets the block according to the type id that passed and set a template to that block and returns it. If we didn't set a custom block for price block, $this->_getPriceBlock($productType) will use default block Mage_Catalog_Block_Product_Price. In our case, this default block is using. Now this block is setting with a template using the method _getPriceBlockTemplate(). Now let us have a look on that method.

protected function _getPriceBlockTemplate($productTypeId)
{
    if (isset($this->_priceBlockTypes[$productTypeId])) {
        if ($this->_priceBlockTypes[$productTypeId]['template'] != '') {
            return $this->_priceBlockTypes[$productTypeId]['template'];
        }
    }
    return $this->_priceBlockDefaultTemplate;
}

As you can see it returns a template, if a template is set based on the type. Else it uses default template catalog/product/price.phtml.

This is the theory. Now let us think what is the problem exists here. We have template only for simple product type. Related products may be of any type. It may be simple, bundle, configurable etc. In the current situation, it uses your custom template only for simple related products. Not for any other types. So you need to set your custom template for every other product types

[edit]

File : app/design/frontend/<package>/<theme>/layout/local.xml

<layout>
    <catalog_product_view>
    <reference name='catalog.product.related'>
            <action method="addPriceBlockType">
                <type>simple</type>
                <block>catalog/product_price</block>
                <template>catalog/product/reseller/price.phtml</template>
            </action>
            <action method="addPriceBlockType">
                <type>bundle</type>
                <block>catalog/product_price</block>
                <template>catalog/product/reseller/price.phtml</template>
            </action>
            <!-- continue this for every type -->
    </reference>
    </catalog_product_view>
</layout>

Hope that make sense !

edit 2

It is wierd that, this method doesn't work. However there is an alternative solution for this. If you are no longer going to use the default price template, you can rewrite Mage_Catalog_Block_Product_Abstract block class and change the default template. However there is another problem. We cannot rewrite this class because it is an abstract class. So the easiest way to overwrite the method is "recreate" the same class in local pool.

File : app\code\local\Mage\Catalog\Block\Product\Abstract.php

<?php
class Mage_Catalog_Block_Product_Abstract extends Mage_Core_Block_Template
{
    /**
     * Rewrite constructor
     *
     */ 
    public function __construct()
    {
        parent::__construct();

        //set template using the method
        $this->addPriceBlockType('simple', 'catalog/product_price', 'catalog/product/reseller/price.phtml')

        //if the above method didn't work, use this along with that
        //sets your own template directly
        $this->__priceBlockDefaultTemplate = 'catalog/product/reseller/price.phtml';
    }

}

I have provided two ways to put your own custom price template. Use the last line, if the first condition fails again. If you are using the code, then you dont need to do any layout updates in anywhere. It will automatically use your custom price template every where it is displaying

Best Answer

Related Solutions

Magento – using local.xml to avoid repetition

Magento – Price Template addPriceBlockType on Related and Upsell Items

edit 2

Related Topic