To remove custom product attributes on module disable in Magento 2, you can use the following steps:
- Create an observer for the module_uninstall event.
- In the observer, get the list of custom product attributes that need to be removed.
- Use the eavSetup->removeAttribute() method to remove each attribute.
Here is an example of an observer for the module_uninstall event:
namespace Vendor\Module\Observer;
use Magento\Eav\Setup\EavSetupFactory;
use Magento\Framework\Event\Observer;
use Magento\Framework\Event\ObserverInterface;
class ModuleUninstallObserver implements ObserverInterface
{
/**
* @var EavSetupFactory
*/
private $eavSetupFactory;
/**
* @param EavSetupFactory $eavSetupFactory
*/
public function __construct(EavSetupFactory $eavSetupFactory)
{
$this->eavSetupFactory = $eavSetupFactory;
}
/**
* @param Observer $observer
*/
public function execute(Observer $observer)
{
$moduleCode = $observer->getData('module_code');
if ($moduleCode === 'Vendor_Module') {
// Get the list of custom product attributes to be removed.
$customProductAttributes = [
'product_attr1',
'product_attr2',
];
// Remove each attribute.
foreach ($customProductAttributes as $attributeCode) {
$eavSetup = $this->eavSetupFactory->create();
$eavSetup->removeAttribute(\Magento\Catalog\Model\Product::ENTITY, $attributeCode);
}
}
}
}To register the observer, add the following code to your module's registration.php file:
<?php
declare(strict_types=1);
use Magento\Framework\Event\ObserverInterface;
return [
'observers' => [
'module_uninstall' => [
'Vendor\Module\Observer\ModuleUninstallObserver' => [
'type' => ObserverInterface::TYPE_MODEL,
'priority' => 10,
],
],
],
];Once you have registered the observer, you can disable your module from the admin panel. The observer will be executed before the module is uninstalled, and the custom product attributes will be removed.
Note that if you enable the module again, the custom product attributes will be recreated.
