Skip to main content

How to add CMS block Programmatically using Patch?

Whenever we deal with content in Magento, we have requirements where we want to provide the power of changing content to the admin but at the same time, we want to display that block's content somewhere according to the developer's code. OR if you want to create multiple blocks with Magento setup, then you can use the below approach to create them.

Create a Patch file in your module at MageInsight/ModuleName/Setup/Patch/Data/AddCmsBlock.php


<?php
namespace MageInsight\ ModuleName\Setup\Patch\Data;

use Magento\Cms\Model\BlockFactory;
use Magento\Framework\Setup\ModuleDataSetupInterface;
use Magento\Framework\Setup\Patch\DataPatchInterface;
use Magento\Framework\Setup\Patch\PatchRevertableInterface;
use Magento\Store\Model\Store;

class AddCmsBlock implements DataPatchInterface, PatchRevertableInterface
{

const CMS_BLOCK_IDENTIFIER = 'block_name';

/**
* @var \Magento\Framework\Setup\ModuleDataSetupInterface
*/
private $moduleDataSetup;

/**
* @var BlockFactory
*/
private $blockFactory;

/**
* InstallOrderStatusesAndInitialSalesConfig constructor.
* @param \Magento\Framework\Setup\ModuleDataSetupInterface $moduleDataSetup
* @param BlockFactory $salesSetupFactory
*/
public function __construct(
\Magento\Framework\Setup\ModuleDataSetupInterface $moduleDataSetup,
BlockFactory $blockFactory
) {
$this->moduleDataSetup = $moduleDataSetup;
$this->blockFactory = $blockFactory;
}

/**
* @inheritDoc
*/
public function apply()
{
$this->moduleDataSetup->startSetup();
$this->blockFactory->create()
->setTitle('Test Block')
->setIdentifier(self::CMS_BLOCK_IDENTIFIER)
->setIsActive(true)
->setContent('Hello')
->setStores([Store::DEFAULT_STORE_ID])
->save();

$this->moduleDataSetup->endSetup();
}

/**
* {@inheritdoc}
*/
public function revert()
{
$sampleCmsBlock = $this->blockFactory->create()->load(self::CMS_BLOCK_IDENTIFIER, 'identifier');
if ($sampleCmsBlock->getId()) {
$sampleCmsBlock->delete();
}
}

/**
* @inheritDoc
*/
public static function getDependencies()
{
return [];
}

/**
* @inheritDoc
*/
public function getAliases()
{
return [];
}
}

Once you add this file, you need to execute the command for the setup upgrade. 

php bin/magento setup:upgrade

php bin/magento cache:clean

And after the command execution is done successfully you can see your CMS block in the admin.

Comments

Popular posts from this blog

Unlocking Success: The Vital Role of the Contact Us Page in E-commerce

In the dynamic realm of e-commerce, where digital transactions reign supreme, the significance of customer communication cannot be overstated. Amidst the plethora of factors influencing the success of an online store, one often overlooked yet fundamentally important element is the Contact Us page. This seemingly humble corner of a website holds immense power, serving as a linchpin in fostering trust, resolving issues, and nurturing customer relationships. Let's delve deeper into why the Contact Us page is not just an afterthought but a strategic asset for e-commerce businesses, backed by proven data. Building Trust and Credibility Trust is the cornerstone of any successful e-commerce venture. According to a survey conducted by Edelman, 81% of consumers say that trusting a brand to do what is right is a deciding factor in their purchasing decisions. A prominently displayed Contact Us page with clear contact information, including a physical address, phone number, and email address, ...

Magento - LogRocket Integration

In today’s competitive eCommerce landscape, understanding user behavior is crucial for optimizing customer experiences and improving conversion rates. Magento 2, a powerful and flexible eCommerce platform, allows merchants to customize their online stores extensively. However, monitoring how users interact with these customizations is often challenging. This is where LogRocket, a modern session replay tool, comes into play. Integrating LogRocket with Magento 2 can provide invaluable insights into user behavior, performance bottlenecks, and UX issues. In this blog post, we’ll walk you through the steps to integrate LogRocket with Magento 2, and how this integration can help you improve your store’s performance and user experience. What is LogRocket? LogRocket is a session replay tool that enables you to record and playback user activity on your website. It tracks interactions such as clicks, scrolls, and form inputs, giving you a clear view of how users navigate your store. In addition,...

Missing crypt key for upgrading Magento

This is my first experience setting up a local docker environment for my project which is in Magento 2 Cloud edition. While doing setup by following Magento docs, I got stuck in the step "Deploy adobe commerce in the Docker Container". Here I was facing the issue: "Missing crypt key for upgrading Magento". Reason : I have taken a DB backup from my staging environment, it has a crypt_key stored which is used by Magento for encrypting the secured data. Solution : If you are not using docker for local setup then, you can simply update the crypt_key value in the app/etc/env.php file. But if you are using docker for your local setup, then you need to include your crypt_key in the config.php inside the .docker folder in your Magento root directory. Open the  .docker/config.php file. Then, search for the key MAGENTO_CLOUD_VARIABLES and add your crypt_key like below: Once you add the crypt_key in the file, try to again execute the  docker-compose run --rm deploy cloud-d...