How is a price rendered on a frontend product view page in Magento 2?

May 12, 2016 - E-Commerce, Fire development, Magento 2

Magento 2 Development

Dmitry Fedyuk illustrates how a price is rendered on a frontend product view page in Magento 2 with the help of the following code:

Table of contents [hide]

1 magento/magento2/blob/2.0.0/app/code/Magento/Catalog/view/frontend/layout/catalog_product_view.xml#L55-L61
2 magento/magento2/blob/2.0.0/app/code/Magento/Catalog/view/base/layout/default.xml#L10-L16
3 magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render.php#L92
4 magento/magento2/blob/2.0.0/app/code/Magento/Catalog/view/base/layout/catalog_product_prices.xml#L9-L38
5 magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render.php#L98
6 magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render/RendererPool.php#L59
7 magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render/RendererPool.php#L227-L241
8 magento/magento2/blob/2.0.0/app/code/Magento/Catalog/view/base/layout/catalog_product_prices.xml#L23-L26
9 magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render/RendererPool.php#L66
10 magento/magento2/blob/2.0.0/app/code/Magento/Catalog/Model/Product.php#L1079-L1090
11 magento/magento2/blob/2.0.0/app/code/Magento/Catalog/Model/Product/Type.php#L161-L170
12 magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/PriceInfo/Factory.php#L56-L87
13 magento/magento2/blob/2.0.0/app/code/Magento/ConfigurableProduct/etc/di.xml#L77-L81
14 magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render/RendererPool.php#L79
15 magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render/RendererPool.php#L85
16 magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render.php#L99
17 magento/magento2/blob/2.0.0/app/code/Magento/Catalog/view/base/templates/product/price/final_price.phtml#L17
18 magento/magento2/blob/2.0.0/app/code/Magento/Catalog/view/base/templates/product/price/final_price.phtml#L44
19 magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render/PriceBox.php#L114-L125
20 magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render/PriceBox.php#L127-L140
21 magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render/RendererPool.php#L142
22 magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render/RendererPool.php#L148
23 magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render/RendererPool.php#L187-L202
24 magento/magento2/blob/2.0.0/app/code/Magento/Catalog/view/base/templates/product/price/amount/default.phtml#L24
25 magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render/Amount.php#L214-L228
26 magento/magento2/blob/2.0.0/app/code/Magento/Directory/Model/PriceCurrency.php#L73-L82
27 magento/magento2/blob/2.0.0/app/code/Magento/Directory/Model/PriceCurrency.php#L114
28 magento/magento2/blob/2.0.0/app/code/Magento/Store/Model/Store.php#L940-L955
29 magento/magento2/blob/2.0.0/app/code/Magento/Store/Model/Store.php#L867-L886
30 magento/magento2/blob/2.0.0/app/code/Magento/Directory/Model/Currency.php#L277-L294

magento/magento2/blob/2.0.0/app/code/Magento/Catalog/view/frontend/layout/catalog_product_view.xml#L55-L61

<block class="Magento\Catalog\Pricing\Render" name="product.price.tier" after="product.info.price">
    <arguments>
        <argument name="price_render" xsi:type="string">product.price.render.default</argument>
        <argument name="price_type_code" xsi:type="string">tier_price</argument>
        <argument name="zone" xsi:type="string">item_view</argument>
    </arguments>
</block>

<argument name="price_render" xsi:type="string">product.price.render.default</argument>

<argument name="price_type_code" xsi:type="string">tier_price</argument>

</arguments>

</block>

magento/magento2/blob/2.0.0/app/code/Magento/Catalog/Pricing/Render.php#L58

 */
protected function _toHtml()
 {
    /** @var PricingRender $priceRender */
    $priceRender = $this->getLayout()->getBlock($this->getPriceRender());
    if ($priceRender instanceof PricingRender) {
        $product = $this->getProduct();
        if ($product instanceof SaleableInterface) {
            $arguments = $this->getData();
            $arguments['render_block'] = $this;
            return $priceRender->render($this->getPriceTypeCode(), $product, $arguments);
        }
    }
    return parent::_toHtml();
}

/**
  * Returns saleable item instance
  *
  * @return Product
  */

protected function _toHtml()

{

/** @var PricingRender $priceRender */

$priceRender = $this->getLayout()->getBlock($this->getPriceRender());

if ($priceRender instanceof PricingRender) {

$product = $this->getProduct();

if ($product instanceof SaleableInterface) {

$arguments = $this->getData();

$arguments['render_block'] = $this;

return $priceRender->render($this->getPriceTypeCode(), $product, $arguments);

}

return parent::_toHtml();

}

/**

* Returns saleable item instance

* @return Product

magento/magento2/blob/2.0.0/app/code/Magento/Catalog/view/base/layout/default.xml#L10-L16

<block class="Magento\Framework\Pricing\Render" name="product.price.render.default">
    <arguments>
        <argument name="price_render_handle" xsi:type="string">catalog_product_prices</argument>
        <argument name="use_link_for_as_low_as" xsi:type="boolean">true</argument>
        <!-- set "override" configuration settings here -->
    </arguments>
</block>

<argument name="price_render_handle" xsi:type="string">catalog_product_prices</argument>

</arguments>

</block>

magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render.php#L92

 * @param array $arguments
 * @return string
 * @throws \InvalidArgumentException
 * @throws \RuntimeException
 */
public function render($priceCode, SaleableInterface $saleableItem, array $arguments = [])
 {
    $useArguments = array_replace($this->_data, $arguments);

    /** @var \Magento\Framework\Pricing\Render\RendererPool $rendererPool */
    $rendererPool = $this->priceLayout->getBlock('render.product.prices');
    if (!$rendererPool) {
        throw new \RuntimeException('Wrong Price Rendering layout configuration. Factory block is missed');
    }

    // obtain concrete Price Render
    $priceRender = $rendererPool->createPriceRender($priceCode, $saleableItem, $useArguments);
    return $priceRender->toHtml();
}

/**

* @param array $arguments

* @return string

* @throws \InvalidArgumentException

* @throws \RuntimeException

public function render($priceCode, SaleableInterface $saleableItem, array $arguments = [])

{

$useArguments = array_replace($this->_data, $arguments);

/** @var \Magento\Framework\Pricing\Render\RendererPool $rendererPool */

$rendererPool = $this->priceLayout->getBlock('render.product.prices');

if (!$rendererPool) {

throw new \RuntimeException('Wrong Price Rendering layout configuration. Factory block is missed');

}

// obtain concrete Price Render

$priceRender = $rendererPool->createPriceRender($priceCode, $saleableItem, $useArguments);

return $priceRender->toHtml();

}

/**

magento/magento2/blob/2.0.0/app/code/Magento/Catalog/view/base/layout/catalog_product_prices.xml#L9-L38

<block class="Magento\Framework\Pricing\Render\RendererPool" name="render.product.prices">
    <arguments>
        <argument name="default" xsi:type="array">
            <item name="default_render_class" xsi:type="string">Magento\Catalog\Pricing\Render\PriceBox</item>
            <item name="default_render_template" xsi:type="string">Magento_Catalog::product/price/default.phtml</item>
            <item name="default_amount_render_class" xsi:type="string">Magento\Framework\Pricing\Render\Amount</item>
            <item name="default_amount_render_template" xsi:type="string">Magento_Catalog::product/price/amount/default.phtml</item>
            <item name="prices" xsi:type="array">
                <item name="special_price" xsi:type="array">
                    <item name="render_template" xsi:type="string">Magento_Catalog::product/price/special_price.phtml</item>
                </item>
                <item name="tier_price" xsi:type="array">
                    <item name="render_template" xsi:type="string">Magento_Catalog::product/price/tier_prices.phtml</item>
                </item>
                <item name="final_price" xsi:type="array">
                    <item name="render_class" xsi:type="string">Magento\Catalog\Pricing\Render\FinalPriceBox</item>
                    <item name="render_template" xsi:type="string">Magento_Catalog::product/price/final_price.phtml</item>
                </item>
                <item name="custom_option_price" xsi:type="array">
                    <item name="amount_render_template" xsi:type="string">Magento_Catalog::product/price/amount/default.phtml</item>

<item name="default_render_class" xsi:type="string">Magento\Catalog\Pricing\Render\PriceBox</item>

<item name="default_render_template" xsi:type="string">Magento_Catalog::product/price/default.phtml</item>

<item name="default_amount_render_class" xsi:type="string">Magento\Framework\Pricing\Render\Amount</item>

<item name="default_amount_render_template" xsi:type="string">Magento_Catalog::product/price/amount/default.phtml</item>

<item name="render_template" xsi:type="string">Magento_Catalog::product/price/special_price.phtml</item>

</item>

<item name="render_template" xsi:type="string">Magento_Catalog::product/price/tier_prices.phtml</item>

</item>

<item name="render_class" xsi:type="string">Magento\Catalog\Pricing\Render\FinalPriceBox</item>

<item name="render_template" xsi:type="string">Magento_Catalog::product/price/final_price.phtml</item>

</item>

<item name="amount_render_template" xsi:type="string">Magento_Catalog::product/price/amount/default.phtml</item>

magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render.php#L98

{
    $useArguments = array_replace($this->_data, $arguments);

    /** @var \Magento\Framework\Pricing\Render\RendererPool $rendererPool */
    $rendererPool = $this->priceLayout->getBlock('render.product.prices');
    if (!$rendererPool) {
        throw new \RuntimeException('Wrong Price Rendering layout configuration. Factory block is missed');
    }

    // obtain concrete Price Render
    $priceRender = $rendererPool->createPriceRender($priceCode, $saleableItem, $useArguments);
    return $priceRender->toHtml();
}

/**
  * Render price amount
  *
  * @param AmountInterface $amount
  * @param PriceInterface $price
  * @param SaleableInterface $saleableItem
  * @param array $arguments

{

$useArguments = array_replace($this->_data, $arguments);

/** @var \Magento\Framework\Pricing\Render\RendererPool $rendererPool */

$rendererPool = $this->priceLayout->getBlock('render.product.prices');

if (!$rendererPool) {

throw new \RuntimeException('Wrong Price Rendering layout configuration. Factory block is missed');

}

// obtain concrete Price Render

$priceRender = $rendererPool->createPriceRender($priceCode, $saleableItem, $useArguments);

return $priceRender->toHtml();

}

/**

* Render price amount

* @param AmountInterface $amount

* @param PriceInterface $price

* @param SaleableInterface $saleableItem

* @param array $arguments

Note that

$priceCode is final_price on a catalog product view;
$type is a product type (e.g. grouped).

magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render/RendererPool.php#L59

) {
    $type = $saleableItem->getTypeId();

    // implement class resolving fallback
    $pattern = [
        $type . '/prices/' . $priceCode . '/render_class',
        $type . '/default_render_class',
        'default/prices/' . $priceCode . '/render_class',
        'default/default_render_class',
    ];
    $renderClassName = $this->findDataByPattern($pattern);
    if (!$renderClassName) {
        throw new \InvalidArgumentException(
            'Class name for price code "' . $priceCode . '" not registered'
        );
    }

    $price = $saleableItem->getPriceInfo()->getPrice($priceCode);
    if (!$price) {
        throw new \InvalidArgumentException(
            'Price model for price code "' . $priceCode . '" not registered'

) {

$type = $saleableItem->getTypeId();

// implement class resolving fallback

$pattern = [

$type . '/prices/' . $priceCode . '/render_class',

$type . '/default_render_class',

'default/prices/' . $priceCode . '/render_class',

'default/default_render_class',

];

$renderClassName = $this->findDataByPattern($pattern);

if (!$renderClassName) {

throw new \InvalidArgumentException(

'Class name for price code "' . $priceCode . '" not registered'

);

}

$price = $saleableItem->getPriceInfo()->getPrice($priceCode);

if (!$price) {

throw new \InvalidArgumentException(

'Price model for price code "' . $priceCode . '" not registered'

Ad as for $renderClassName, it may be \Magento\Catalog\Pricing\Render\FinalPriceBox.

magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render/RendererPool.php#L227-L241

/**
  * @param array $pattern
  * @return null|string
  */
protected function findDataByPattern(array $pattern)
 {
    $data = null;
    foreach ($pattern as $key) {
        $data = $this->getData($key);
        if ($data) {
            break;
        }
    }
    return $data;
}

/**

* @param array $pattern

* @return null|string

protected function findDataByPattern(array $pattern)

{

$data = null;

foreach ($pattern as $key) {

$data = $this->getData($key);

if ($data) {

break;

}

return $data;

}

magento/magento2/blob/2.0.0/app/code/Magento/Catalog/view/base/layout/catalog_product_prices.xml#L23-L26

<item name="final_price" xsi:type="array">
    <item name="render_class" xsi:type="string">Magento\Catalog\Pricing\Render\FinalPriceBox</item>
    <item name="render_template" xsi:type="string">Magento_Catalog::product/price/final_price.phtml</item>
</item>

<item name="render_class" xsi:type="string">Magento\Catalog\Pricing\Render\FinalPriceBox</item>

<item name="render_template" xsi:type="string">Magento_Catalog::product/price/final_price.phtml</item>

</item>

magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render/RendererPool.php#L66

    'default/prices/' . $priceCode . '/render_class',
    'default/default_render_class',
];
$renderClassName = $this->findDataByPattern($pattern);
if (!$renderClassName) {
    throw new \InvalidArgumentException(
        'Class name for price code "' . $priceCode . '" not registered'
    );
}

$price = $saleableItem->getPriceInfo()->getPrice($priceCode);
if (!$price) {
    throw new \InvalidArgumentException(
        'Price model for price code "' . $priceCode . '" not registered'
    );
}

$arguments['data'] = $data;
$arguments['rendererPool'] = $this;
$arguments['price'] = $price;
$arguments['saleableItem'] = $saleableItem;

'default/prices/' . $priceCode . '/render_class',

'default/default_render_class',

];

$renderClassName = $this->findDataByPattern($pattern);

if (!$renderClassName) {

throw new \InvalidArgumentException(

'Class name for price code "' . $priceCode . '" not registered'

);

}

$price = $saleableItem->getPriceInfo()->getPrice($priceCode);

if (!$price) {

throw new \InvalidArgumentException(

'Price model for price code "' . $priceCode . '" not registered'

);

}

$arguments['data'] = $data;

$arguments['rendererPool'] = $this;

$arguments['price'] = $price;

$arguments['saleableItem'] = $saleableItem;

As for $price, it may be \Magento\ConfigurableProduct\Pricing\Price\FinalPrice.

magento/magento2/blob/2.0.0/app/code/Magento/Catalog/Model/Product.php#L1079-L1090

/**
  * Get product Price Info object
  *
  * @return \Magento\Framework\Pricing\PriceInfo\Base
  */
public function getPriceInfo()
 {
    if (!$this->_priceInfo) {
        $this->_priceInfo = $this->_catalogProductType->getPriceInfo($this);
    }
    return $this->_priceInfo;
}

/**

* Get product Price Info object

* @return \Magento\Framework\Pricing\PriceInfo\Base

public function getPriceInfo()

{

if (!$this->_priceInfo) {

$this->_priceInfo = $this->_catalogProductType->getPriceInfo($this);

}

return $this->_priceInfo;

}

magento/magento2/blob/2.0.0/app/code/Magento/Catalog/Model/Product/Type.php#L161-L170

/**
  * Get Product Price Info object
  *
  * @param Product $saleableItem
  * @return \Magento\Framework\Pricing\PriceInfoInterface
  */
public function getPriceInfo(Product $saleableItem)
 {
    return $this->_priceInfoFactory->create($saleableItem);
}

/**

* Get Product Price Info object

* @param Product $saleableItem

* @return \Magento\Framework\Pricing\PriceInfoInterface

public function getPriceInfo(Product $saleableItem)

{

return $this->_priceInfoFactory->create($saleableItem);

}

magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/PriceInfo/Factory.php#L56-L87

public function create(SaleableInterface $saleableItem, array $arguments = [])
 {
    $type = $saleableItem->getTypeId();

    if (isset($this->types[$type]['infoClass'])) {
        $priceInfo = $this->types[$type]['infoClass'];
    } else {
        $priceInfo = $this->types['default']['infoClass'];
    }

    if (isset($this->types[$type]['prices'])) {
        $priceCollection = $this->types[$type]['prices'];
    } else {
        $priceCollection = $this->types['default']['prices'];
    }

    $arguments['saleableItem'] = $saleableItem;
    $quantity = $saleableItem->getQty();
    if ($quantity) {
        $arguments['quantity'] = $quantity;

public function create(SaleableInterface $saleableItem, array $arguments = [])

{

$type = $saleableItem->getTypeId();

if (isset($this->types[$type]['infoClass'])) {

$priceInfo = $this->types[$type]['infoClass'];

} else {

$priceInfo = $this->types['default']['infoClass'];

}

if (isset($this->types[$type]['prices'])) {

$priceCollection = $this->types[$type]['prices'];

} else {

$priceCollection = $this->types['default']['prices'];

}

$arguments['saleableItem'] = $saleableItem;

$quantity = $saleableItem->getQty();

if ($quantity) {

$arguments['quantity'] = $quantity;

Note that:

$priceInfo may be Magento\Framework\Pricing\PriceInfo\Base;
$priceCollection – \Magento\ConfigurableProduct\Pricing\Price\Collection.

magento/magento2/blob/2.0.0/app/code/Magento/ConfigurableProduct/etc/di.xml#L77-L81

<virtualType name="Magento\ConfigurableProduct\Pricing\Price\Collection" type="Magento\Framework\Pricing\Price\Collection">
    <arguments>
        <argument name="pool" xsi:type="object">Magento\ConfigurableProduct\Pricing\Price\Pool</argument>
    </arguments>
</virtualType>

<argument name="pool" xsi:type="object">Magento\ConfigurableProduct\Pricing\Price\Pool</argument>

</arguments>

</virtualType>

magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render/RendererPool.php#L79

            'Price model for price code "' . $priceCode . '" not registered'
        );
    }

    $arguments['data'] = $data;
    $arguments['rendererPool'] = $this;
    $arguments['price'] = $price;
    $arguments['saleableItem'] = $saleableItem;

    /** @var \Magento\Framework\View\Element\Template $renderBlock */
    $renderBlock = $this->getLayout()->createBlock($renderClassName, '', $arguments);
    if (!$renderBlock instanceof PriceBoxRenderInterface) {
        throw new \InvalidArgumentException(
            'Block "' . $renderClassName . '" must implement \Magento\Framework\Pricing\Render\PriceBoxRenderInterface'
        );
    }
    $renderBlock->setTemplate($this->getRenderBlockTemplate($type, $priceCode));
    return $renderBlock;
}

/**

'Price model for price code "' . $priceCode . '" not registered'

);

}

$arguments['data'] = $data;

$arguments['rendererPool'] = $this;

$arguments['price'] = $price;

$arguments['saleableItem'] = $saleableItem;

/** @var \Magento\Framework\View\Element\Template $renderBlock */

$renderBlock = $this->getLayout()->createBlock($renderClassName, '', $arguments);

if (!$renderBlock instanceof PriceBoxRenderInterface) {

throw new \InvalidArgumentException(

'Block "' . $renderClassName . '" must implement \Magento\Framework\Pricing\Render\PriceBoxRenderInterface'

);

}

$renderBlock->setTemplate($this->getRenderBlockTemplate($type, $priceCode));

return $renderBlock;

}

/**

As for $renderBlock, it may be \Magento\Catalog\Pricing\Render\FinalPriceBox.

magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render/RendererPool.php#L85

    $arguments['price'] = $price;
    $arguments['saleableItem'] = $saleableItem;

    /** @var \Magento\Framework\View\Element\Template $renderBlock */
    $renderBlock = $this->getLayout()->createBlock($renderClassName, '', $arguments);
    if (!$renderBlock instanceof PriceBoxRenderInterface) {
        throw new \InvalidArgumentException(
            'Block "' . $renderClassName . '" must implement \Magento\Framework\Pricing\Render\PriceBoxRenderInterface'
        );
    }
    $renderBlock->setTemplate($this->getRenderBlockTemplate($type, $priceCode));
    return $renderBlock;
}

/**
  * Create amount renderer
  *
  * @param AmountInterface $amount
  * @param SaleableInterface $saleableItem
  * @param PriceInterface $price
  * @param array $data

$arguments['price'] = $price;

$arguments['saleableItem'] = $saleableItem;

/** @var \Magento\Framework\View\Element\Template $renderBlock */

$renderBlock = $this->getLayout()->createBlock($renderClassName, '', $arguments);

if (!$renderBlock instanceof PriceBoxRenderInterface) {

throw new \InvalidArgumentException(

'Block "' . $renderClassName . '" must implement \Magento\Framework\Pricing\Render\PriceBoxRenderInterface'

);

}

$renderBlock->setTemplate($this->getRenderBlockTemplate($type, $priceCode));

return $renderBlock;

}

/**

* Create amount renderer

* @param AmountInterface $amount

* @param SaleableInterface $saleableItem

* @param PriceInterface $price

* @param array $data

magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render/RendererPool.php#L210-L225

protected function getRenderBlockTemplate($type, $priceCode)
 {
    $pattern = [
        $type . '/prices/' . $priceCode . '/render_template',
        $type . '/default_render_template',
        'default/prices/' . $priceCode . '/render_template',
        'default/default_render_template',
    ];
    $template = $this->findDataByPattern($pattern);
    if (!$template) {
        throw new \InvalidArgumentException(
            'Price code "' . $priceCode . '" render block not configured'
        );
    }
    return $template;
}

protected function getRenderBlockTemplate($type, $priceCode)

{

$pattern = [

$type . '/prices/' . $priceCode . '/render_template',

$type . '/default_render_template',

'default/prices/' . $priceCode . '/render_template',

'default/default_render_template',

];

$template = $this->findDataByPattern($pattern);

if (!$template) {

throw new \InvalidArgumentException(

'Price code "' . $priceCode . '" render block not configured'

);

}

return $template;

}

The expected result may look like Magento_Catalog::product/price/final_price.phtml.

magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render.php#L99

    $useArguments = array_replace($this->_data, $arguments);

    /** @var \Magento\Framework\Pricing\Render\RendererPool $rendererPool */
    $rendererPool = $this->priceLayout->getBlock('render.product.prices');
    if (!$rendererPool) {
        throw new \RuntimeException('Wrong Price Rendering layout configuration. Factory block is missed');
    }

    // obtain concrete Price Render
    $priceRender = $rendererPool->createPriceRender($priceCode, $saleableItem, $useArguments);
    return $priceRender->toHtml();
}

/**
  * Render price amount
  *
  * @param AmountInterface $amount
  * @param PriceInterface $price
  * @param SaleableInterface $saleableItem
  * @param array $arguments
  * @return string

$useArguments = array_replace($this->_data, $arguments);

/** @var \Magento\Framework\Pricing\Render\RendererPool $rendererPool */

$rendererPool = $this->priceLayout->getBlock('render.product.prices');

if (!$rendererPool) {

throw new \RuntimeException('Wrong Price Rendering layout configuration. Factory block is missed');

}

// obtain concrete Price Render

$priceRender = $rendererPool->createPriceRender($priceCode, $saleableItem, $useArguments);

return $priceRender->toHtml();

}

/**

* Render price amount

* @param AmountInterface $amount

* @param PriceInterface $price

* @param SaleableInterface $saleableItem

* @param array $arguments

* @return string

magento/magento2/blob/2.0.0/app/code/Magento/Catalog/view/base/templates/product/price/final_price.phtml#L17

// @codingStandardsIgnoreFile

?>

<?php
 /** @var \Magento\Catalog\Pricing\Render\FinalPriceBox $block */

 $productId = $block->getSaleableItem()->getId();

 /** @var \Magento\Catalog\Pricing\Price\RegularPrice $priceModel */
 $priceModel = $block->getPriceType('regular_price');

 /** @var \Magento\Catalog\Pricing\Price\FinalPrice $finalPriceModel */
 $finalPriceModel = $block->getPriceType('final_price');
 $idSuffix = $block->getIdSuffix() ? $block->getIdSuffix() : '';
 $schema = ($block->getZone() == 'item_view') ? true : false;
 ?>
<?php if ($block->hasSpecialPrice()): ?>
<span class="special-price">
    <?php /* @escapeNotVerified */ echo $block->renderAmount($finalPriceModel->getAmount(), [
         'display_label'     => __('Special Price'),

// @codingStandardsIgnoreFile

<?php

/** @var \Magento\Catalog\Pricing\Render\FinalPriceBox $block */

$productId = $block->getSaleableItem()->getId();

/** @var \Magento\Catalog\Pricing\Price\RegularPrice $priceModel */

$priceModel = $block->getPriceType('regular_price');

/** @var \Magento\Catalog\Pricing\Price\FinalPrice $finalPriceModel */

$finalPriceModel = $block->getPriceType('final_price');

$idSuffix = $block->getIdSuffix() ? $block->getIdSuffix() : '';

$schema = ($block->getZone() == 'item_view') ? true : false;

<?php if ($block->hasSpecialPrice()): ?>

<?php /* @escapeNotVerified */ echo $block->renderAmount($finalPriceModel->getAmount(), [

'display_label' => __('Special Price'),

$priceModel not only supports the \Magento\/Framework\Pricing\Price\PriceInterface interface but also may be an instance of the \Magento\ConfigurableProduct\Pricing\Price\ConfigurableRegularPrice class.

Note that a PHPDock comment for the $priceModel variable should be:

/** @var \Magento\Framework\Pricing\Price\PriceInterface $priceModel */

1	/** @var \Magento\Framework\Pricing\Price\PriceInterface $priceModel */

The $priceModel may be, for example, an instane of the \Magento\ConfigurableProduct\Pricing\Price\ConfigurableRegularPrice class, which is not a descendant of the \Magento\Catalog\Pricing\Price\RegularPrice class.

magento/magento2/blob/2.0.0/app/code/Magento/Catalog/view/base/templates/product/price/final_price.phtml#L44

<span class="old-price">
    <?php /* @escapeNotVerified */ echo $block->renderAmount($priceModel->getAmount(), [
         'display_label'     => __('Regular Price'),
         'price_id'          => $block->getPriceId('old-price-' . $idSuffix),
         'price_type'        => 'oldPrice',
         'include_container' => true,
         'skip_adjustments'  => true
     ]); ?>
</span>
<?php else: ?>
<?php /* @escapeNotVerified */ echo $block->renderAmount($finalPriceModel->getAmount(), [
     'price_id'          => $block->getPriceId('product-price-' . $idSuffix),
     'price_type'        => 'finalPrice',
     'include_container' => true,
     'schema' => $schema
 ]); ?>
<?php endif; ?>

<?php if ($block->showMinimalPrice()): ?>
<?php if ($block->getUseLinkForAsLowAs()):?>
    <a href="<?php /* @escapeNotVerified */ echo $block->getSaleableItem()->getProductUrl(); ?>" class="minimal-price-link">

<?php /* @escapeNotVerified */ echo $block->renderAmount($priceModel->getAmount(), [

'display_label' => __('Regular Price'),

'price_id' => $block->getPriceId('old-price-' . $idSuffix),

'price_type' => 'oldPrice',

'include_container' => true,

'skip_adjustments' => true

]); ?>

<?php else: ?>

<?php /* @escapeNotVerified */ echo $block->renderAmount($finalPriceModel->getAmount(), [

'price_id' => $block->getPriceId('product-price-' . $idSuffix),

'price_type' => 'finalPrice',

'include_container' => true,

'schema' => $schema

]); ?>

<?php endif; ?>

<?php if ($block->showMinimalPrice()): ?>

<?php if ($block->getUseLinkForAsLowAs()):?>

<a href="<?php /* @escapeNotVerified */ echo $block->getSaleableItem()->getProductUrl(); ?>" class="minimal-price-link">

magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render/PriceBox.php#L114-L125

/**
  * @param AmountInterface $amount
  * @param array $arguments
  * @return string
  */
public function renderAmount(AmountInterface $amount, array $arguments = [])
 {
    $arguments = array_replace($this->getData(), $arguments);

    //@TODO AmountInterface does not contain toHtml() method
    return $this->getAmountRender($amount, $arguments)->toHtml();
}

/**

* @param AmountInterface $amount

* @param array $arguments

* @return string

public function renderAmount(AmountInterface $amount, array $arguments = [])

{

$arguments = array_replace($this->getData(), $arguments);

//@TODO AmountInterface does not contain toHtml() method

return $this->getAmountRender($amount, $arguments)->toHtml();

}

magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render/PriceBox.php#L127-L140

/**
  * @param AmountInterface $amount
  * @param array $arguments
  * @return AmountRenderInterface
  */
protected function getAmountRender(AmountInterface $amount, array $arguments = [])
 {
    return $this->rendererPool->createAmountRender(
        $amount,
        $this->getSaleableItem(),
        $this->getPrice(),
        $arguments
    );
}

/**

* @param AmountInterface $amount

* @param array $arguments

* @return AmountRenderInterface

protected function getAmountRender(AmountInterface $amount, array $arguments = [])

{

return $this->rendererPool->createAmountRender(

$amount,

$this->getSaleableItem(),

$this->getPrice(),

$arguments

);

}

magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render/RendererPool.php#L142

    $arguments['amount'] = $amount;

    if ($saleableItem) {
        $arguments['saleableItem'] = $saleableItem;
        if ($price) {
            $arguments['price'] = $price;
        }
    }

    /** @var \Magento\Framework\View\Element\Template $amountBlock */
    $amountBlock = $this->getLayout()->createBlock($renderClassName, '', $arguments);
    if (!$amountBlock instanceof AmountRenderInterface) {
        throw new \InvalidArgumentException(
            'Block "' . $renderClassName . '" must implement \Magento\Framework\Pricing\Render\AmountRenderInterface'
        );
    }
    $amountBlock->setTemplate($this->getAmountRenderBlockTemplate($type, $priceCode));
    return $amountBlock;
}

/**

$arguments['amount'] = $amount;

if ($saleableItem) {

$arguments['saleableItem'] = $saleableItem;

if ($price) {

$arguments['price'] = $price;

}

/** @var \Magento\Framework\View\Element\Template $amountBlock */

$amountBlock = $this->getLayout()->createBlock($renderClassName, '', $arguments);

if (!$amountBlock instanceof AmountRenderInterface) {

throw new \InvalidArgumentException(

'Block "' . $renderClassName . '" must implement \Magento\Framework\Pricing\Render\AmountRenderInterface'

);

}

$amountBlock->setTemplate($this->getAmountRenderBlockTemplate($type, $priceCode));

return $amountBlock;

}

/**

As for $amountBlock, it could be an instance of the \Magento\Framework\Pricing\Render\Amount class.

magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render/RendererPool.php#L148

        }
    }

    /** @var \Magento\Framework\View\Element\Template $amountBlock */
    $amountBlock = $this->getLayout()->createBlock($renderClassName, '', $arguments);
    if (!$amountBlock instanceof AmountRenderInterface) {
        throw new \InvalidArgumentException(
            'Block "' . $renderClassName . '" must implement \Magento\Framework\Pricing\Render\AmountRenderInterface'
        );
    }
    $amountBlock->setTemplate($this->getAmountRenderBlockTemplate($type, $priceCode));
    return $amountBlock;
}

/**
  * @param SaleableInterface $saleableItem
  * @param PriceInterface $price
  * @return array
  */
public function getAdjustmentRenders(SaleableInterface $saleableItem = null, PriceInterface $price = null)
 {

}

/** @var \Magento\Framework\View\Element\Template $amountBlock */

$amountBlock = $this->getLayout()->createBlock($renderClassName, '', $arguments);

if (!$amountBlock instanceof AmountRenderInterface) {

throw new \InvalidArgumentException(

'Block "' . $renderClassName . '" must implement \Magento\Framework\Pricing\Render\AmountRenderInterface'

);

}

$amountBlock->setTemplate($this->getAmountRenderBlockTemplate($type, $priceCode));

return $amountBlock;

}

/**

* @param SaleableInterface $saleableItem

* @param PriceInterface $price

* @return array

public function getAdjustmentRenders(SaleableInterface $saleableItem = null, PriceInterface $price = null)

{

magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render/RendererPool.php#L187-L202

protected function getAmountRenderBlockTemplate($type, $priceCode)
 {
    $pattern = [
        $type . '/prices/' . $priceCode . '/amount_render_template',
        $type . '/default_amount_render_template',
        'default/prices/' . $priceCode . '/amount_render_template',
        'default/default_amount_render_template',
    ];
    $template = $this->findDataByPattern($pattern);
    if (!$template) {
        throw new \InvalidArgumentException(
            'For type "' . $type . '" amount render block not configured'
        );
    }
    return $template;
}

protected function getAmountRenderBlockTemplate($type, $priceCode)

{

$pattern = [

$type . '/prices/' . $priceCode . '/amount_render_template',

$type . '/default_amount_render_template',

'default/prices/' . $priceCode . '/amount_render_template',

'default/default_amount_render_template',

];

$template = $this->findDataByPattern($pattern);

if (!$template) {

throw new \InvalidArgumentException(

'For type "' . $type . '" amount render block not configured'

);

}

return $template;

}

Possible result is Magento_Catalog::product/price/amount/default.phtml

magento/magento2/blob/2.0.0/app/code/Magento/Catalog/view/base/templates/product/price/amount/default.phtml#L24

    <?php echo $block->getSchema() ? ' itemprop="offers" itemscope itemtype="http://schema.org/Offer"' : '' ?>>
<?php if ($block->getDisplayLabel()): ?>
    <span class="price-label"><?php /* @escapeNotVerified */ echo $block->getDisplayLabel(); ?></span>
<?php endif; ?>
<span <?php if ($block->getPriceId()): ?> id="<?php /* @escapeNotVerified */ echo $block->getPriceId() ?>"<?php endif;?>
    <?php echo($block->getPriceDisplayLabel()) ? 'data-label="' . $block->getPriceDisplayLabel() . $block->getPriceDisplayInclExclTaxes() . '"' : '' ?>
    data-price-amount="<?php /* @escapeNotVerified */ echo $block->getDisplayValue(); ?>"
    data-price-type="<?php /* @escapeNotVerified */ echo $block->getPriceType(); ?>"
    class="price-wrapper <?php /* @escapeNotVerified */ echo $block->getPriceWrapperCss(); ?>"
    <?php echo $block->getSchema() ? ' itemprop="price"' : '' ?>>
    <?php /* @escapeNotVerified */ echo $block->formatCurrency($block->getDisplayValue(), (bool)$block->getIncludeContainer()) ?>
</span>
<?php if ($block->hasAdjustmentsHtml()): ?>
    <?php echo $block->getAdjustmentsHtml() ?>
<?php endif; ?>
<?php if ($block->getSchema()): ?>
    <meta itemprop="priceCurrency" content="<?php /* @escapeNotVerified */ echo $block->getDisplayCurrencyCode()?>" />
<?php endif; ?>
</span>

<?php echo $block->getSchema() ? ' itemprop="offers" itemscope itemtype="http://schema.org/Offer"' : '' ?>>

<?php if ($block->getDisplayLabel()): ?>

<?php /* @escapeNotVerified */ echo $block->getDisplayLabel(); ?>

<?php endif; ?>

getPriceId()): ?> id="<?php /* @escapeNotVerified */ echo $block->getPriceId() ?>"<?php endif;?>

<?php echo($block->getPriceDisplayLabel()) ? 'data-label="' . $block->getPriceDisplayLabel() . $block->getPriceDisplayInclExclTaxes() . '"' : '' ?>

data-price-amount="<?php /* @escapeNotVerified */ echo $block->getDisplayValue(); ?>"

data-price-type="<?php /* @escapeNotVerified */ echo $block->getPriceType(); ?>"

class="price-wrapper <?php /* @escapeNotVerified */ echo $block->getPriceWrapperCss(); ?>"

<?php echo $block->getSchema() ? ' itemprop="price"' : '' ?>>

<?php /* @escapeNotVerified */ echo $block->formatCurrency($block->getDisplayValue(), (bool)$block->getIncludeContainer()) ?>

<?php if ($block->hasAdjustmentsHtml()): ?>

<?php echo $block->getAdjustmentsHtml() ?>

<?php endif; ?>

<?php if ($block->getSchema()): ?>

<?php endif; ?>

magento/magento2/blob/2.0.0/lib/internal/Magento/Framework/Pricing/Render/Amount.php#L214-L228

/**
  * Format price value
  *
  * @param float $amount
  * @param bool $includeContainer
  * @param int $precision
  * @return float
  */
public function formatCurrency(
     $amount,
     $includeContainer = true,
     $precision = PriceCurrencyInterface::DEFAULT_PRECISION
 ) {
    return $this->priceCurrency->format($amount, $includeContainer, $precision);
}

/**

* Format price value

* @param float $amount

* @param bool $includeContainer

* @param int $precision

* @return float

public function formatCurrency(

$amount,

$includeContainer = true,

$precision = PriceCurrencyInterface::DEFAULT_PRECISION

) {

return $this->priceCurrency->format($amount, $includeContainer, $precision);

}

magento/magento2/blob/2.0.0/app/code/Magento/Directory/Model/PriceCurrency.php#L73-L82

public function format(
     $amount,
     $includeContainer = true,
     $precision = self::DEFAULT_PRECISION,
     $scope = null,
     $currency = null
 ) {
    return $this->getCurrency($scope, $currency)
        ->formatPrecision($amount, $precision, [], $includeContainer);
}

public function format(

$amount,

$includeContainer = true,

$precision = self::DEFAULT_PRECISION,

$scope = null,

$currency = null

) {

return $this->getCurrency($scope, $currency)

->formatPrecision($amount, $precision, [], $includeContainer);

}

magento/magento2/blob/2.0.0/app/code/Magento/Directory/Model/PriceCurrency.php#L114

    if ($currency instanceof Currency) {
        $currentCurrency = $currency;
    } elseif (is_string($currency)) {
        $currency = $this->currencyFactory->create()
            ->load($currency);
        $baseCurrency = $this->getStore($scope)
            ->getBaseCurrency();
        $currentCurrency = $baseCurrency->getRate($currency) ? $currency : $baseCurrency;
    } else {
        $currentCurrency = $this->getStore($scope)
            ->getCurrentCurrency();
    }

    return $currentCurrency;
}

/**
  * @param null|string|bool|int|\Magento\Framework\App\ScopeInterface $scope
  * @param \Magento\Framework\Model\AbstractModel|string|null $currency
  * @return string
  */

if ($currency instanceof Currency) {

$currentCurrency = $currency;

} elseif (is_string($currency)) {

$currency = $this->currencyFactory->create()

->load($currency);

$baseCurrency = $this->getStore($scope)

->getBaseCurrency();

$currentCurrency = $baseCurrency->getRate($currency) ? $currency : $baseCurrency;

} else {

$currentCurrency = $this->getStore($scope)

->getCurrentCurrency();

}

return $currentCurrency;

}

/**

* @param null|string|bool|int|\Magento\Framework\App\ScopeInterface $scope

* @param \Magento\Framework\Model\AbstractModel|string|null $currency

* @return string

magento/magento2/blob/2.0.0/app/code/Magento/Store/Model/Store.php#L940-L955

public function getCurrentCurrency()
 {
    $currency = $this->getData('current_currency');

    if ($currency === null) {
        $currency = $this->currencyFactory->create()->load($this->getCurrentCurrencyCode());
        $baseCurrency = $this->getBaseCurrency();

        if (!$baseCurrency->getRate($currency)) {
            $currency = $baseCurrency;
            $this->setCurrentCurrencyCode($baseCurrency->getCode());
        }
        $this->setData('current_currency', $currency);
    }
    return $currency;
}

public function getCurrentCurrency()

{

$currency = $this->getData('current_currency');

if ($currency === null) {

$currency = $this->currencyFactory->create()->load($this->getCurrentCurrencyCode());

$baseCurrency = $this->getBaseCurrency();

if (!$baseCurrency->getRate($currency)) {

$currency = $baseCurrency;

$this->setCurrentCurrencyCode($baseCurrency->getCode());

}

$this->setData('current_currency', $currency);

}

return $currency;

}

magento/magento2/blob/2.0.0/app/code/Magento/Store/Model/Store.php#L867-L886

public function getCurrentCurrencyCode()
 {
    // try to get currently set code among allowed
    $code = $this->_httpContext->getValue(Context::CONTEXT_CURRENCY);
    $code = $code === null ? $this->_getSession()->getCurrencyCode() : $code;
    if (empty($code)) {
        $code = $this->getDefaultCurrencyCode();
    }
    if (in_array($code, $this->getAvailableCurrencyCodes(true))) {
        return $code;
    }

    // take first one of allowed codes
    $codes = array_values($this->getAvailableCurrencyCodes(true));
    if (empty($codes)) {
        // return default code, if no codes specified at all
        return $this->getDefaultCurrencyCode();
    }
    return array_shift($codes);
}

public function getCurrentCurrencyCode()

{

// try to get currently set code among allowed

$code = $this->_httpContext->getValue(Context::CONTEXT_CURRENCY);

$code = $code === null ? $this->_getSession()->getCurrencyCode() : $code;

if (empty($code)) {

$code = $this->getDefaultCurrencyCode();

}

if (in_array($code, $this->getAvailableCurrencyCodes(true))) {

return $code;

}

// take first one of allowed codes

$codes = array_values($this->getAvailableCurrencyCodes(true));

if (empty($codes)) {

// return default code, if no codes specified at all

return $this->getDefaultCurrencyCode();

}

return array_shift($codes);

}

magento/magento2/blob/2.0.0/app/code/Magento/Directory/Model/Currency.php#L277-L294

public function formatPrecision(
     $price,
     $precision,
     $options = [],
     $includeContainer = true,
     $addBrackets = false
 ) {
    if (!isset($options['precision'])) {
        $options['precision'] = $precision;
    }
    if ($includeContainer) {
        return '<span class="price">' . ($addBrackets ? '[' : '') . $this->formatTxt(
            $price,
            $options
        ) . ($addBrackets ? ']' : '') . '</span>';
    }
    return $this->formatTxt($price, $options);
}

public function formatPrecision(

$price,

$precision,

$options = [],

$includeContainer = true,

$addBrackets = false

) {

if (!isset($options['precision'])) {

$options['precision'] = $precision;

}

if ($includeContainer) {

return '' . ($addBrackets ? '[' : '') . $this->formatTxt(

$price,

$options

) . ($addBrackets ? ']' : '') . '';

}

return $this->formatTxt($price, $options);

}

Source

More tips from Magento 2 cookbook

Post Tags:magento 2 Magento 2 Developer’s Cookbook price rendering

← Previous Post Next Post →

Magento 2 Google Sheets Integration Guide

Have you ever known that importing data to Magento 2 from Google Sheets is possible? It is not a joke,… Read more…
Magento 2 Page Builder Import & Export

In the following article, we shed light on Magento 2 Page Builder. You will learn its core features. After that,… Read more…
How to Import Custom CSV to Magento 2 Programmatically

Let's discuss the Magento 2 import of custom CSV files. Recently, we've been surfing across endless StackExchange discussions and stumbled… Read more…
How to Import Magento 2 Product by Store View?

You've come to the right place if you run a multilingual storefront or use several different store views. Below, we… Read more…
Magento 2 MSI User Guide: How to Import & Export Magento 2 MSI (Multi Source Inventory)

This Magento 2 MSI user guide briefly explains the platform's multi-source inventory functionality and then focuses on the Magento 2… Read more…
Magento Error Log to Debug Magento 2 Import & Export

Today, we are going to discuss the Magento error log for import and export processes. Since Magento 2 doesn’t have any… Read more…
Magento 2 Import of Custom Attributes: How to Import Products with Custom Attributes to Magento 2

When you import products to Magento 2, you may face various difficulties. Transferring them to your website without headaches is… Read more…
How to Import Data via REST API into Magento 2

Today, we'd like to draw your attention to the Magento 2 REST API Import. Depending on the edition of your… Read more…
How to Create a Custom Import in Magento 2

Although the default import and export instruments of Magento 2 are enough to satisfy the basic data transfer needs, you… Read more…
Magento 2 Import: How To Fix Value For Attribute Contains Incorrect Value Error

In the following article, you will discover a universal algorithm for solving Magento 2 errors associated with incorrect attribute values.… Read more…
Magento 2 Imported Resource (Image) Could Not Be Downloaded: How To Fix This Magento 2 Import Error

In the following article, we explore a problem that prevents Magento users from importing images. You may be familiar with… Read more…
Magento 2 General System Exception Happened: How To Fix Error During Magento 2 Import

If you regularly deal with Magento 2 import processes, you might have faced the following message: General System Exception Happened.… Read more…
How to Import & Export Product Attributes for Magento 2 (Along with Attribute Values & Sets)

Today, we are going to talk about the import and export of product attributes for Magento 2. Operating an e-commerce store… Read more…
How to Import Product Images into Magento 2 in Bulk

Below, we describe how to import product images in Magento 2 using CSV. Since it is a part of a product… Read more…
Magento 2 Bulk API & Asynchronous Import

Below, we discuss the Magento 2 bulk API and the corresponding asynchronous import processes. After a short introduction to the… Read more…
How to Import Database in Magento 2

Recently, we’ve spotted a question on StackExchange regarding the Magento 2 database import. David Duong faced problems while transferring a… Read more…
Magento 2 B2B Requisition List Guide: How to Manage & Import Requisition Lists in Magento 2

In the following article, we explain what a requisition list of Magento 2 is - a feature exclusively available in Adobe… Read more…
Magento 2 Shared Catalog Guide: How to Import and Export Shared Catalogs in Magento 2

The following article explores Magento 2 shared catalogs - a B2B entity exclusively available to Adobe Commerce users. You will learn what a… Read more…
Magento 2 B2B Company Guide: Revealing Company Structure & Import

If you want to migrate from the existing Magento B2B website, you may face a problem when companies cannot be… Read more…
How to Import & Export Magento 2 Gift Cards

Gift cards are a useful addition to every e-commerce website. They are frequently used on e-commerce websites with any assortment:… Read more…

Related posts