{"id":1343,"date":"2024-04-12T19:20:46","date_gmt":"2024-04-12T13:50:46","guid":{"rendered":"https:\/\/magecurious.com\/blog\/?p=1343"},"modified":"2025-01-12T20:51:27","modified_gmt":"2025-01-12T15:21:27","slug":"how-to-bind-custom-text-while-adding-a-comment-in-sales-order-view-in-magento-2","status":"publish","type":"post","link":"https:\/\/magecurious.com\/blog\/how-to-bind-custom-text-while-adding-a-comment-in-sales-order-view-in-magento-2\/","title":{"rendered":"How To Bind Custom Text While Adding A Comment In Sales Order View In Magento 2 \u00a0 \u00a0 \u00a0"},"content":{"rendered":"\n

Hello Everyone,       <\/p>\n\n\n\n

In this blog, we will learn about how to Bind Custom Text while Adding Comment in Sales Order View in Magento 2.<\/p>\n\n\n\n

Store Admin can customize anything as per requirements.<\/p>\n\n\n\n

Without wasting your time, let us guide you straight away. Follow the easy step given below to Bind Custom Text while Add Comment in Sales Order View in Magento 2.<\/p>\n\n\n\n

STEPS FOR BIND CUSTOM TEXT IN SALES ORDER VIEW IN MAGENTO 2<\/strong><\/p>\n\n\n\n

Step 1: Create di.xml file<\/strong><\/p>\n\n\n\n

app\/code\/Vendor\/Extension\/etc\/adminhtml\/di.xml<\/strong><\/p>\n\n\n

\n<?xml version="1.0"?>\n\n<config xmlns:xsi='http:\/\/www.w3.org\/2001\/XMLSchema-instance' xsi:noNamespaceSchemaLocation='..\/..\/..\/..\/..\/lib\/internal\/Magento\/Framework\/ObjectManager\/etc\/config.xsd'>\n\n\u00a0\u00a0\u00a0\u00a0<type name='Magento\\Sales\\Controller\\Adminhtml\\Order\\AddComment'>\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<plugin name='order_add_comment' type='Vendor\\Extension\\Plugin\\Adminhtml\\Order\\AddComment'\/>\n\n\u00a0\u00a0\u00a0\u00a0<\/type>\n\n<\/config>\n<\/pre><\/div>\n\n\n
Step 2: Create AddComment.php file<\/strong><\/p>\n\n\n\n
app\/code\/Vendor\/Extension\/Plugin\/Adminhtml\/Order\/AddComment.php<\/strong><\/p>\n\n\n
\n<?php \nnamespace Vendor\\Extension\\Plugin\\Adminhtml\\Order;\n\nuse Magento\\Framework\\App\\RequestInterface;\nuse Magento\\Backend\\Model\\Auth\\Session;\nuse Magento\\Framework\\Exception\\NoSuchEntityException;\nuse Magento\\Framework\\Exception\\InputException;\nuse Magento\\Sales\\Api\\OrderRepositoryInterface;\nuse Magento\\Sales\\Api\\Data\\OrderStatusHistoryInterface;\nuse Magento\\Sales\\Api\\OrderStatusHistoryRepositoryInterface;\nuse Magento\\Framework\\Registry;\nuse Magento\\Framework\\View\\Result\\PageFactory;\nuse Magento\\Framework\\Controller\\Result\\JsonFactory;\nuse Magento\\Framework\\Controller\\Result\\Redirect;\nuse Magento\\Sales\\Model\\Order\\Email\\Sender\\OrderCommentSender;\nuse Magento\\Framework\\AuthorizationInterface;\n\nclass AddComment\n{\n    public const ADMIN_RESOURCE = 'Magento_Sales::comment';\n    public const ADMIN_SALES_EMAIL_RESOURCE = 'Magento_Sales::emails';\n\n    protected $_request;\n    protected $authSession;\n    protected $orderStatusRepository;\n    protected $orderRepository;\n    protected $_coreRegistry = null;\n    protected $resultPageFactory;\n    private $resultJsonFactory;\n    protected $orderCommentSender;\n    protected $_authorization;\n    protected $resultRedirectFactory;\n\n    public function __construct(\n        RequestInterface  $request,\n        Session $authSession,\n        OrderStatusHistoryRepositoryInterface $orderStatusRepository,\n        OrderRepositoryInterface $orderRepository,\n        Registry $coreRegistry,\n        PageFactory $resultPageFactory,\n        JsonFactory $resultJsonFactory,\n        Redirect $resultRedirectFactory,\n        OrderCommentSender $orderCommentSender,\n        AuthorizationInterface $authorization\n    )\n    {\n    \t$this->authSession = $authSession;\n        $this->_request = $request;\n        $this->orderStatusRepository = $orderStatusRepository;\n        $this->orderRepository = $orderRepository;\n        $this->_coreRegistry = $coreRegistry;\n        $this->resultPageFactory = $resultPageFactory;\n        $this->resultJsonFactory = $resultJsonFactory;\n        $this->resultRedirectFactory = $resultRedirectFactory;\n        $this->orderCommentSender = $orderCommentSender;\n        $this->_authorization = $authorization;\n    }\n\n    public function aroundExecute(\\Magento\\Sales\\Controller\\Adminhtml\\Order\\AddComment $subject, callable $proceed)\n    {\n        $order = $this->_initOrder();\n\t        if ($order)\n                {\n\t            try\n                    {\n\t                $data = $subject->getRequest()->getPost('history');\n\n\t                if (empty($data['comment']) && $data['status'] == $order->getDataByKey('status'))\n                        {\n\t                    throw new \\Magento\\Framework\\Exception\\LocalizedException(\n\t                        __('The comment is missing. Enter and try again.')\n\t                    );\n\t                }\n\n\t                $order->setStatus($data['status']);\n\t                $notify = $data['is_customer_notified'] ?? false;\n\t                $visible = $data['is_visible_on_front'] ?? false;\n\n\t                if ($notify && !$this->_authorization->isAllowed(self::ADMIN_SALES_EMAIL_RESOURCE))\n                        {\n\t                    $notify = false;\n\t                }\n\n\t                $comment = trim(strip_tags($data['comment']));\n\t                $adminusername = $this->authSession->getUser()->getUsername();\n\t                $history = $order->addStatusHistoryComment($comment.'<br><b>Admin User :<\/b> '.$adminusername, $data['status']);\n\t                $history->setIsVisibleOnFront($visible);\n\t                $history->setIsCustomerNotified($notify);\n\t                $history->save();\n\n\t                $order->save();\n\t               \n\t                $this->orderCommentSender->send($order, $notify, $comment);\n\n\t                return $this->resultPageFactory->create();\n\t            }\n                    catch (\\Magento\\Framework\\Exception\\LocalizedException $e)\n                    {\n\t                $response = ['error' => true, 'message' => $e->getMessage()];\n\t            }\n                    catch (\\Exception $e)\n                    {\n\t                $response = ['error' => true, 'message' => __('We cannot add order history.')];\n\t            }\n\t            if (is_array($response))\n                    {\n\t                $resultJson = $this->resultJsonFactory->create();\n\t                $resultJson->setData($response);\n\t                return $resultJson;\n\t            }\n\t      }\n              return $this->resultRedirectFactory->create()->setPath('sales\/*\/');\n    }\n    \n    public function _initOrder()\n    {\n        $id = $this->_request->getParam('order_id');\n        try\n        {\n            $order = $this->orderRepository->get($id);\n        }\n        catch (NoSuchEntityException $e)\n        {\n            return false;\n        }\n        catch (InputException $e)\n        {\n            return false;\n        }\n        $this->_coreRegistry->register('sales_order', $order);\n        $this->_coreRegistry->register('current_order', $order);\n        return $order;\n    }\n}\n<\/pre><\/div>\n\n\n
Step 3: Finally run the below commands<\/strong><\/p>\n\n\n\n
$ php bin\/magento cache:clean<\/p>\n\n\n\n
$ php bin\/magento cache:flush<\/p>\n\n\n\n
Step 4: Output:<\/strong><\/p>\n\n\n\n
\"\"\/<\/figure>\n\n\n\n
<\/div>\n\n\n\n
Final Thoughts:<\/strong><\/p>\n\n\n\n
So this was the easiest way which we have told you in this blog. This is how you can Bind Custom Text while Adding a Comment in Sales Order View in Magento 2. Hope you liked the blog.<\/p>\n\n\n\n
So quickly go to the comment box and tell me how you like this blog?<\/p>\n\n\n\n
Stay tuned with us on our site to get new updates of Magento.<\/strong><\/p>\n\n\n\n
Thanks for reading and visiting our site.<\/p>\n\n\n
      
          
        How useful was this post?      <\/p>              
        Click on a star to rate it!      <\/p>        
      
                      
  •               <\/i>          <\/li>                  
  •               <\/i>          <\/li>                  
  •               <\/i>          <\/li>                  
  •               <\/i>          <\/li>                  
  •               <\/i>          <\/li>              <\/ul>    <\/div>    
    <\/p>