Add Product Custom Option Programmatically Magento2

We will use the event catalog_product_save_before to create product custom option programmatically in magento2.

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <event name="catalog_product_save_before">
        <observer name="magemonkeys_customoption_add_custom_option" instance="Magemonkeys\Customoption\Observer\CatalogProductSaveBeforeObserver"/>
    </event>
</config>

<?xml version="1.0"?>

<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">

</event>

</config>

In our CatalogProductSaveBeforeObserver class we get the product object. We have to check if the custom option with name “Custom Option” and type field already exists.

If not existed, we have to create an array with the options to be created.

<?php

namespace Magemonkeys\Customoption\Observer;

use Magento\Framework\Event\ObserverInterface;
use Magento\Catalog\Api\Data\ProductCustomOptionInterface;
use Magento\Catalog\Model\Product\OptionFactory;

class CatalogProductSaveBeforeObserver implements ObserverInterface
{
    /**
     * @var OptionFactory
     */
    protected $productOptionFactory;

    /**
     * Catalog Product After Save constructor.
     * @param OptionFactory $productOptionFactory
     */
    public function __construct(
        OptionFactory $productOptionFactory
    ) {
        $this->productOptionFactory = $productOptionFactory;
    }

    /**
     * Catalog Product Before Save
     *
     * @param \Magento\Framework\Event\Observer $observer
     * @return void
     */
    public function execute(\Magento\Framework\Event\Observer $observer)
    {
        $product = $observer->getEvent()->getProduct();

        $exist = false;
        //check if the custom option exists
        foreach ($product->getOptions() as $option) {
            if ($option->getGroupByType() == ProductCustomOptionInterface::OPTION_TYPE_FIELD
                && $option->getTitle() == 'Custom Option') {
                $exist = true;
            }
        }

        if (!$exist) {
            try {
                $optionArray = [
                    'title' => 'Custom Option',
                    'type' => 'field',
                    'is_require' => false,
                    'sort_order' => 1,
                    'price' => 0,
                    'price_type' => 'fixed',
                    'sku' => '',
                    'max_characters' => 0
                ];
                $option = $this->productOptionFactory->create();
                $option->setProductId($product->getId())
                    ->setStoreId($product->getStoreId())
                    ->addData($optionArray);
                $product->addOption($option);
            } catch (\Exception $e) {
                //throw new CouldNotSaveException(__('Something went wrong while saving option.'));
            }
        }
    }
}

<?php

namespace Magemonkeys\Customoption\Observer;

use Magento\Framework\Event\ObserverInterface;

use Magento\Catalog\Api\Data\ProductCustomOptionInterface;

use Magento\Catalog\Model\Product\OptionFactory;

class CatalogProductSaveBeforeObserver implements ObserverInterface

{

/**

* @var OptionFactory

protected $productOptionFactory;

/**

* Catalog Product After Save constructor.

* @param OptionFactory $productOptionFactory

public function __construct(

OptionFactory $productOptionFactory

) {

$this->productOptionFactory = $productOptionFactory;

}

/**

* Catalog Product Before Save

* @param \Magento\Framework\Event\Observer $observer

* @return void

public function execute(\Magento\Framework\Event\Observer $observer)

{

$product = $observer->getEvent()->getProduct();

$exist = false;

//check if the custom option exists

foreach ($product->getOptions() as $option) {

if ($option->getGroupByType() == ProductCustomOptionInterface::OPTION_TYPE_FIELD

&& $option->getTitle() == 'Custom Option') {

$exist = true;

}

if (!$exist) {

try {

$optionArray = [

'title' => 'Custom Option',

'type' => 'field',

'is_require' => false,

'sort_order' => 1,

'price' => 0,

'price_type' => 'fixed',

'sku' => '',

'max_characters' => 0

];

$option = $this->productOptionFactory->create();

$option->setProductId($product->getId())

->setStoreId($product->getStoreId())

->addData($optionArray);

$product->addOption($option);

} catch (\Exception $e) {

//throw new CouldNotSaveException(__('Something went wrong while saving option.'));

}

Fill the below form if you have any Magento programming need.

Add an image programmatically from any url in Magento 2
[crayon-63e0a09296560168182244/] Using above fucntion Images can be imported directly from...
Magento 2 : Override the Category view block file
Override view block using di.xml and add the below code...
How to check list of Layout XML called for a specific page in Magento 2?
You can check a list of called layout XML for...
Magento 2 : Setup PWA from Scratch
Follow the below steps to install and set up PWA...
How to remove leading zero’s from the order, invoice and shipment number in Magento 2?
If you want to remove all leading zero's from order,...

Author Info

Magento Certified Developer

Hire J. Lakum

Let’s have a call

Fill the form & Get Installation Support