How to Run Extension Setup Script from Magento 2 Root

If you are developing custom Magento extensions, you might have database script which require to be properly run when you install the extension. Sometimes while installation, it may happen where the extension is installed but database script is missing. Here the setup scripts come in place where you need to run extension setup script from Magento 2 root to properly install the extension.

Let’s have a look at setup script to run extension from Magento 2 root.

Here, as a sample code, I’m showing to create a category and product attribute through setup script.

getObjectManager();

$state = $obj->get('Magento\Framework\App\State');
$state->setAreaCode('frontend');

try
{
 $setup = $obj->get('Magento\Framework\Setup\ModuleDataSetupInterface');
 $eav_setup_factory = $obj->get('Magento\Eav\Setup\EavSetupFactory');
 
  $setup->startSetup();
    $eavSetup = $eav_setup_factory->create(['setup' => $setup]);
  // Product Attribute
        $eavSetup->addAttribute(
            \Magento\Catalog\Model\Product::ENTITY,
            'customattribute',
            [
                'type' => 'text',
                'label' => 'Custom Attribute Label',
    'backend' => '',
                'input' => 'textarea',
    'wysiwyg_enabled'   => true,
    'source' => '',
                'required' => false,
                'sort_order' => 3,
                'global' => \Magento\Catalog\Model\ResourceModel\Eav\Attribute::SCOPE_STORE,
                'group' => 'custom attribute group',
                'used_in_product_listing' => true,
                'visible_on_front' => true
            ]
        );
  
  //Category Attribute Create Script
  $eavSetup->addAttribute(
            \Magento\Catalog\Model\Category::ENTITY,
            ' customattribute ',
   [
     'group' => 'custom attribute group',
     'label' => 'custom attribute label',
                 'type' => 'text',
                 'input' => 'textarea',
     'global' => \Magento\Eav\Model\Entity\Attribute\ScopedAttributeInterface::SCOPE_STORE,
     'required' => false,
                 'sort_order' => 25,
     'source' => '',
                 'is_used_in_grid' => true,
                 'is_visible_in_grid' => false,
                 'is_filterable_in_grid' => true,
     'wysiwyg_enabled' => true
            ]
        );
        $setup->endSetup();
echo "Code Executed Successfully";
}
catch(\Exception $e)
{
 echo $e->getMessage();
 exit;
}

Running above setup script from Magento 2 root will instantly install the extension with related missing database. Hope this blog has helped you to properly install extension. If you get confused or have questions regarding, feel free to comment, I’ll be happy to help you.