Being an Open source platform, Magento supports lots of customization and development. However, store owners are always in hunt of new feature and enhancement to existing Magento experience. Nowadays, lots of extensions are available in the market that will help store owners provide personalized experience. From landing onto the Magento store to the last step of product checkout, whole process plays a very important role for store owners in terms of providing great shopping experience for the products customers want to purchase. Default Magento supports various product types, but sometimes store owner needs to provide additional options to their customers to serve customized product and better service to the customer.
Recently, one of our clients willing to get various additional options from the customers so, he can easily deliver customized product fit to their requirements without affecting core Magento functionalities. After spending some time in coding, finally we have successfully delivered smile on a client’s face. But today I want to share that code with you guys.
First of all, we need to create two observer files and one Magento event file to implement this functionality. Basically, the Observer is a special class in Magento that executes whenever any an event gets fired.
Firstly, create events.xml file at Vendor/Extension/etc/events.xml and add below code into that file.
|
1 |
<!--?xml version="1.0"?--> |
Once you have created this file, now you need to Create another file and named as CheckoutCartAddObserver.php at Vendor/Extension/Observer/CheckoutCartAddObserver.php
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
namespace Vendor\Extension\Observer; use Magento\Framework\Event\Observer as EventObserver; use Magento\Framework\Event\ObserverInterface; class CheckoutCartAddObserver implements ObserverInterface { protected $_layout; protected $_storeManager; protected $_request; public function __construct( \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\View\LayoutInterface $layout, \Magento\Framework\App\RequestInterface $request ) { $this->_layout = $layout; $this->_storeManager = $storeManager; $this->_request = $request; } public function execute(EventObserver $observer) { $item = $observer->getQuoteItem(); $additionalOptions = array(); if ($additionalOption = $item->getOptionByCode('additional_options')){ $additionalOptions = (array) unserialize($additionalOption->getValue()); } $additionalOptions[] = [ 'label' => 'Additional Options Label', 'value' => 'Additional Options Value' ]; } if(count($additionalOptions) > 0) { $item->addOption(array( 'product_id' => $item->getProductId(), 'code' => 'additional_options', 'value' => serialize($additionalOptions) )); } } } |
Create another observer file named as QuoteSubmitObserver.php at Vendor/Extension/Observer/QuoteSubmitObserver.php
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
namespace Vendor\Extension\Observer; use Magento\Framework\Event\Observer as EventObserver; use Magento\Framework\Event\ObserverInterface; class QuoteSubmitObserver implements ObserverInterface { private $quoteItems = []; private $quote = null; private $order = null; public function execute(EventObserver $observer) { $this->quote = $observer->getQuote(); $this->order = $observer->getOrder(); foreach($this->order->getItems() as $orderItem) { if($quoteItem = $this->getQuoteItemById($orderItem->getQuoteItemId())) { if ($additionalOptionsQuote = $quoteItem->getOptionByCode('additional_options')) { if($additionalOptionsOrder = $orderItem->getProductOptionByCode('additional_options')) { $additionalOptions = array_merge($additionalOptionsQuote, $additionalOptionsOrder); } else { $additionalOptions = $additionalOptionsQuote; } if(count($additionalOptions) > 0) { $options = $orderItem->getProductOptions(); $options['additional_options'] = unserialize($additionalOptions->getValue()); $orderItem->setProductOptions($options); } } } } } private function getQuoteItemById($id) { if(empty($this->quoteItems)) { foreach($this->quote->getItems() as $item) { $this->quoteItems[$item->getId()] = $item; } } if(array_key_exists($id, $this->quoteItems)) { return $this->quoteItems[$id]; } return null; } } |
Once you have created both the file at desired location, an additional option will visible to your Magento front-end. You can even customize this code according to your need of adding additional options. If you are facing any issue while implementing this code or to have some talk about this blog, don’t forget to leave comments below & to share this article with your Magento friends.
And Yeah ! hit the starts below if this code helped you to implement additional options.
Happy Coding !
How to send the same details using REST API
You can use the same additional_optional in REST API.
The “sales_model_service_quote_submit_before” is not calling so that the new custom option is not reflected an order page.
The “sales_model_service_quote_submit_before” is not calling so that the new custom option is not reflected an order page.