Skip to main content

How to add a new field in admin form using Block?

Although Magento recommends using ui_component for creating grid or form in admin, Magento core itself has multiple forms & grid which is created using block(Old technique). So let's see how to add a field using the block technique:

For this first, we need to locate the block class which contains _prepareForm() method. And then we will create the Plugin for this class.

Step 1: Add the below code to the di.xml file of the custom module.

<?xml version="1.0" ?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
	<type name="Magento\CheckoutAgreements\Block\Adminhtml\Agreement\Edit\Form">
        <plugin name="add_embassy_field" type="MageInsight\CheckoutAgreements\Plugin\Block\Adminhtml\Agreement\Edit\Form" sortOrder="1"/>
</type> </config>

Step 2: Create a new file inside your module plugin folder like MageInsight\CheckoutAgreements\Plugin\Block\Adminhtml\Agreement\Edit\Form.php

<?php

namespace MageInsight\CheckoutAgreements\Plugin\Block\Adminhtml\Agreement\Edit;

use MageInsight\Embassy\Model\Options\Embassy;
 
class Form
{
    protected $embassy;

    protected $_coreRegistry;

    public function __construct(
        \Magento\Framework\Registry $_coreRegistry,
        Embassy $embassy
    ) {
        $this->embassy = $embassy;
        $this->_coreRegistry = $_coreRegistry;
    }

    public function aroundGetFormHtml(
        \Magento\CheckoutAgreements\Block\Adminhtml\Agreement\Edit\Form $subject,
        \Closure $proceed)
    {
        $form = $subject->getForm();
        if (is_object($form)) {
            $fieldset = $form->getElement('base_fieldset');
            $model = $this->_coreRegistry->registry('checkout_agreement');
            $fieldset->addField(
                'embassies',
                'multiselect',
                [
                    'name' => 'embassies[]',
                    'label' => __('Embassies'),
                    'title' => __('EMbassies'),
                    'required' => false,
                    'values' => $this->embassy->toOptionArray(),
                    'value' => !empty($model->getData('embassies')) ? json_decode($model->getData('embassies'), true) : []
                ]
            );
        }
 
        return $proceed();
    }
}

Step 3: If you are adding a multi-select field, then the form submit will pass values in an array and we have to take care of this. In my case, I have added a Plugin for the beforeSave() which will take care of values every time the entity is saved by admin. Below is the code of that plugin. 

<?php

namespace MageInsight\CheckoutAgreements\Plugin\Model;

class Agreement
{
    public function aroundBeforeSave(
        \Magento\CheckoutAgreements\Model\Agreement $subject,
        \Closure $proceed
    ) {
        if (!empty($subject->getData('embassies'))) {
            $subject->setData('embassies', json_encode($subject->getData('embassies')));
        }

        return $proceed();
    }    
}

Conclusion: By following the above steps you will be able to save the values in the form and see the saved values in edit form. I have saved the values in JSON format because later it makes my work easy to filter using JSON_SEARCH queries.

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,...

Using Composer Update is a Crime: Why Magento Developers Should Avoid It

As a Magento developer, managing third-party modules via Composer is essential for keeping your project organized and up to date. However, when installing a new module, there’s one command that might seem tempting, yet can lead to chaos if not used carefully: composer update Yes, you read that right—using composer update can be a crime (against your project, that is). In this blog, we’ll explore why running composer update without caution can be risky, and why you should think twice before pulling the trigger. Let’s break it down. What Does composer update Do? At first glance, composer update seems harmless. When you run it, Composer checks for newer versions of every package listed in your composer.json file and updates them to the latest compatible versions based on your version constraints. That sounds good, right? Why wouldn't you want the latest updates? Well, here's where things get tricky. The Hidden Risk of composer update Running composer update doesn't just u...