Magento 2: How to display static block content in modal overlay

Magento 2: How to display static block content in modal overlay

Many times we need to show some sort of information in modal overlay when customer comes to the site.
We can use it for many kind of purposes like newsletter subscription form, coupon codes or just some
general information.
In this article I’ll show you how to create the most basic functionality around this.

The challenge

When customer comes to our site, we want to show load specific static block content
into the modal overlay and show it only once to every customer.


We should start by creating new module in Magento 2.

For that purpose start by creating app/code/Inchoo/ModalOverlay/registration.php
with following content:

* @category Inchoo
* @package Inchoo_ModalOverlay
* @copyright Copyright (c) Inchoo (

Continue by creating app/code/Inchoo/ModalOverlay/etc/module.xml.
Put the following inside:

<?xml version="1.0"?>
@category Inchoo
@package Inchoo_ModalOverlay
@copyright Copyright (c) Inchoo (
<config xmlns:xsi=""
<module name="Inchoo_ModalOverlay" setup_version="1.0.0">

That will create a new module in Magento 2.
What we want to do now is to create block that will be shown in modal.
For that purpose, let’s continue by creating another file called
This one should have the following content:

namespace Inchoo\ModalOverlay\Block;
use Magento\Cms\Api\BlockRepositoryInterface;
use Magento\Cms\Api\Data\BlockInterface;
use Magento\Framework\Exception\LocalizedException;
use Magento\Framework\View\Element\Template;
use Magento\Framework\View\Element\Template\Context;
* Class ModalOverlay
* @category Inchoo
* @package Inchoo_ModalOverlay
* @copyright Copyright (c) Inchoo (
class ModalOverlay extends Template
* @var BlockRepositoryInterface
private $blockRepository;
* ModalOverlay constructor.
* @param BlockRepositoryInterface $blockRepository
* @param Context $context
* @param array $data
public function __construct(
BlockRepositoryInterface $blockRepository,
Context $context,
array $data = []
) {
$this->blockRepository = $blockRepository;
parent::__construct($context, $data);
* Retrieve modal overlay content
* @param $identifier
* @return bool|string
public function getContent($identifier)
try {
/** @var BlockInterface $block */
$block = $this->blockRepository->getById($identifier);
$content = $block->getContent();
} catch (LocalizedException $e) {
$content = false;
return $content;

Newly created block needs to have a template, so let’s create it and initialize our JavaScript app/code/Inchoo/ModalOverlay/view/frontend/templates/modal_overlay.phtml

* @category Inchoo
* @package Inchoo_ModalOverlay
* @copyright Copyright (c) Inchoo (
<?php /** @var Inchoo\ModalOverlay\Block\ModalOverlay $block */ ?>
<?php if ($content = $block->getContent('this-should-be-renamed')) :?>
<div id="modal-overlay" style="display:none;">
<?php /* @noEscape */ echo $content ?>
<script type="text/x-magento-init">
"*": {
"Magento_Ui/js/core/app": {
"components": {
"modal_overlay": {
"component": "Inchoo_ModalOverlay/js/modal_overlay"
<?php endif;?>

Let’s add previously created block into layout on every page.
For that purpose, create app/code/Inchoo/ModalOverlay/view/frontend/layout/default.xml and
put the following inside:

<?xml version="1.0"?>
@category Inchoo
@package Inchoo_ModalOverlay
@copyright Copyright (c) Inchoo (
<page xmlns:xsi=""
<referenceContainer name="content">
<block class="Inchoo\ModalOverlay\Block\ModalOverlay"

And finally, let’s add app/code/Inchoo/ModalOverlay/view/frontend/web/js/modal_overlay.js
with the following content:

* @category Inchoo
* @package Inchoo_ModalOverlay
* @copyright Copyright (c) Inchoo (
], function (Component, $, modal, storage) {
'use strict';
var cacheKey = 'modal-overlay';
var getData = function () {
return storage.get(cacheKey)();
var saveData = function (data) {
storage.set(cacheKey, data);
if ($.isEmptyObject(getData())) {
var modal_overlay = {
'modal_overlay': false
return Component.extend({
initialize: function () {
var options = {
type: 'popup',
responsive: true,
innerScroll: false,
title: false,
buttons: false
var modal_overlay_element = $('#modal-overlay');
var popup = modal(options, modal_overlay_element);
modal_overlay_element.css("display", "block");
var modalContainer = $("#modal-overlay");
if(this.getModalOverlay()) {
return false;
setModalOverlay: function (data) {
var obj = getData();
obj.modal_overlay = data;
getModalOverlay: function () {
return getData().modal_overlay;


That is it. All that’s left is to create a static block and activate the module.
This should give you a basic module that you can modify however fits you best.

If you want to see how we can help you with these types of custom work on your Magento store, get in touch!

Related Inchoo Services

You made it all the way down here so you must have enjoyed this post! You may also like:

Inchoo & Magento in 2024 and Beyond Lucija Majstrovic
, | 0

Inchoo & Magento in 2024 and Beyond

Magento 2 Customer Groups Configuration Josip Kovacevic
Josip Kovacevic, | 2

Magento 2 Customer Groups Configuration

How to add a custom columns to the Magento 2 products grid Ivan Matozan
, | 6

How to add a custom columns to the Magento 2 products grid


  1. I am struggling with above code. Now, just created another module with Inchoo itself as the vendor. Copied and pasted all the codes. Created a static block and included its id at appropriate place in the phtml file. Checked several times that I missed anything. But, it just says “failed to load the “Inchoo_ModalOverlay/js/modal_overlay”. Using 2.4.6 version of Magento

  2. Hey, I hope you are doing well. Thanks for the tutorial.
    i want to do this exact thing, but i want the popup to show based on a cookie I set in backend, how do I have to change the js to achieve this?

  3. Can you please explain this part?

    “All that’s left is to create a static block and activate the module.”

    Activating the module is done with
    sudo php bin/magento setup:upgrade

    How to map with static block. Infact how to create one and bind?

    It’ll be a great help if anyone can explain or guide.

    Many thanks in advance.

  4. Hi there,

    I guess, the Indian peeps stole your content: https://www.cubettech dot com/blog/display-static-block-content-in-modal-box-magento-2/

    I have a question regarding the modal display.
    Is it stored in a cookie? A session cookie? Cache? I can see that it shows one time and then halts until I clear my cache.

Leave a Reply

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

You may use these HTML tags and attributes: <a href="" title=""> <blockquote cite=""> <code> <del datetime=""> <em> <s> <strike> <strong>. You may use following syntax for source code: <pre><code>$current = "Inchoo";</code></pre>.

Tell us about your project

Drop us a line. We'd love to know more about your project.