Wednesday , May 24 2017
Home >> All tutorial >> Add Cache Support to Magento Blocks

Add Cache Support to Magento Blocks

Hey guys, 

Welcome back to our Magento Tutorial today!

Caching is a important feature of Magento to maintain performance of a Magento site. By default, Magento provides a caching mechanism for Layout, Blocks, Collection Data, and Configurations. Normally layout updates, configuration data, etc. remain the same each time a page is loaded. Fetching layout updates from multiple files or loading and merging configuration data from XML files and the database cost significant amounts of execution time. Caching provides a mechanism to prepare and store all this data conveniently so it can quickly be retrieved on page loads to save execution time.

In this tutorial, we will go through how to prepare your custom blocks for block caching.

In block caching, Magento stores the HTML output of the blocks into its cache and subsequently loads the contents directly from it. Magento uses block cache only for the header, footer and top navigation, as their contents is not frequently changed. However, using caching for other blocks is also possible.

Cache Lifetime

The simplest way of enabling cache for a particular block is to set cache_lifetime data. This can be done through layout XML:

block type="mb_example/cached" name="magebase.example
 action method="setCacheLifetime"
 lifetime3600/lifetime !-- Cache Lifetime of 1 hour --

Or it can also be defined in the _construct() method of a block class:

class Magebase_Example_Block_Cached extends Mage_Core_Block_Abstract
 protected function _construct()

Cache Lifetime is time specified in seconds, which defines the expiration time of the cache. In our example we have defined the cache lifetime as 3600 seconds i.e. 1 hour. So our cache would expire after 1 hour, and then re-generated. If cache lifetime is passed as false, the cache will never expire.

Cache Tags

Additionally to the cache lifetime, we can specify cache tags. Tags are useful to programmatically identify particular cache types. In our example, we will add two cache tags: store and cms_block

class Magebase_Example_Block_Cached extends Mage_Core_Block_Abstract
 protected function _construct()
 'cache_lifetime' = 3600,
 'cache_tags' = array(Mage_Core_Model_Store::CACHE_TAG, Mage_Cms_Model_Block::CACHE_TAG)

Cache Keys

Probably the most important part of preparing your blocks for caching is specifying the cache key. The cache key uniquely identifies each cache item. If a cache key is not specified, Magento uses the block’s name in the layout as the cache key. However, it is a good practice to define a custom cache key when adding cache support to the block.

To define a cache key, we can either add a static value of cache_key through the layout XML similarly to the cache lifetime in the above example or add a data key called cache_key through the _construct() method. A unique static string value is sufficient to define a cache key, however, we should consider a scenario when the block has different output for different stores, themes, etc…

For example, a block can have different HTML output for different themes. If we define a static cache key, it will be the same for any theme. So our cache will store the first rendered output, regardless of the theme. When a theme is changed or used by another website in the same Magento install, the same HTML would be returned from cache. That’s why it’s a good idea to have the cache key depended on the theme, package, store etc.

To create a unique cache key, we should override the method getCacheKeyInfo() in our block class and return an array of cache key parts:

public function getCacheKeyInfo()
 return array(

Here, the method returns an array. The first element ‘EXAMPLE_BLOCK’ is our unique identifier. The second element is the current store id. The third element is 1 if current URL is secure (https://) or 0 if URL is not secure. The fourth element is the theme package name. The fifth element is the theme name for rendering templates. The cache key for the block will be generated using all these array elements.

In our example, the cache key will automatically be changed when:

  1. Customer browse to different store
  2. URL is changed from secure (https://) to unsecure (http://) or vice versa
  3. Theme package is changed by administrator
  4. Theme for templates is changed by administrator

As you can see, the array elements for the cache key should be chosen according to the block’s output for different factors. On some site you may be allowing for a currency or language switcher, or both, so in those cases you will need to add more key elements to create a unique cache key specific to the selected currency and/or language, and so on.


We hope you found this short tutorial useful. We recommend adding block cache support for your blocks, especially if you’re creating custom home page blocks or widgets. It will improve the response of the site considerably. 

Ready to foster your knowledge with MAGENTO 2 BASIC GUIDE

The new Order Success combo with Magento 2 Inventory Management, Magento 2 Order Fulfillment, Magento 2 Dropship, Magento 2 Barcode Management and Magento 2 Purchase Management

Is your site still a mess and Magento extensions are not enough to save your site? Save your site with Magento Web Development Services now

magento services

About Champ

Leave a Reply

Your email address will not be published. Required fields are marked *