Add Custom Comment to Magento 2 Orders Programmatically

Magento 2 Add custom comment programmatically to order with order id

Posted by Yogesh Khasturi

February 15, 2021Magento 6 131 Views

Hello Magento Folks!

In our Previous Blog we discussed How To Add Date of Birth Field in Customer Registration Form in Magento 2? today we will learn about How to add Status History Comment to the order by id in Magento 2?

Sometimes while doing customization we have need to add History Comment in order for doing that we need to use interface, Magento\Sales\Api\OrderStatusHistoryRepositoryInterface to add a comment.

<?php
namespace Webiators\CustomOrderComment\Block;

use Magento\Sales\Api\OrderStatusHistoryRepositoryInterface;
use Magento\Sales\Api\OrderRepositoryInterface;
use Magento\Framework\Exception\NoSuchEntityException;
use Magento\Sales\Api\Data\OrderStatusHistoryInterface;

class CustomComent
{

    /** @var OrderStatusHistoryRepositoryInterface */
    private $orderStatusRepository;

    /** @var OrderRepositoryInterface */
    private $orderRepository;

    public function __construct(
        OrderStatusHistoryRepositoryInterface $orderStatusRepository,
        OrderRepositoryInterface $orderRepository
    ) {
        $this->orderStatusRepository = $orderStatusRepository;
        $this->orderRepository = $orderRepository;
    }

    /**
     * add custom Comnnet to order History
     *
     * @param int $orderId
     * @return OrderStatusHistoryInterface|null
     */
    public function addCustomOrderComment(int $orderId)
    {


        $order = $this->orderRepository->get($orderId);
        $orderHistory = null;

        if ($order) {
            $comment = $order->addStatusHistoryComment(
                'This is custom order commnet to test'
            );

            $orderHistory = $this->orderStatusRepository->save($comment);
        }
        return $orderHistory;
    }
}

<?php

namespace Webiators\CustomOrderComment\Block;

use Magento\Sales\Api\OrderStatusHistoryRepositoryInterface;

use Magento\Sales\Api\OrderRepositoryInterface;

use Magento\Framework\Exception\NoSuchEntityException;

use Magento\Sales\Api\Data\OrderStatusHistoryInterface;

class CustomComent

{

/** @var OrderStatusHistoryRepositoryInterface */

private $orderStatusRepository;

/** @var OrderRepositoryInterface */

private $orderRepository;

public function __construct(

OrderStatusHistoryRepositoryInterface $orderStatusRepository,

OrderRepositoryInterface $orderRepository

) {

$this->orderStatusRepository = $orderStatusRepository;

$this->orderRepository = $orderRepository;

}

/**

* add custom Comnnet to order History

* @param int $orderId

* @return OrderStatusHistoryInterface|null

public function addCustomOrderComment(int $orderId)

{

$order = $this->orderRepository->get($orderId);

$orderHistory = null;

if ($order) {

$comment = $order->addStatusHistoryComment(

'This is custom order commnet to test'

);

$orderHistory = $this->orderStatusRepository->save($comment);

}

return $orderHistory;

}

By Adding Above code in any class of magento 2 and by passing order id in the above method you will be able to add any order comment in the comment history just like this.

$orderId = 1225;
$orderHistoryComment= $block->addCustomOrderComment($orderId);

1 2	$orderId = 1225; $orderHistoryComment= $block->addCustomOrderComment($orderId);

I believe this blog helps you and was easy enough to make you understand. if you still have doubt please feel free to leave a comment below to discuss more.

Happy Coding
Thanks

Hit 5 Stars if you find this post helpful

5 (based on 1 Reviews)

People also searched for

6 Comments

Pingback:Magento Tech Digest #151 – Max Pronko
Helpful tutorial! For more advanced Magento 2 customizations, consider taking expert guidance.

SMB User
July 14, 2025, 5:51 am
Helpful tutorial on adding custom comments to orders in Magento 2!

SMB User
July 14, 2025, 7:12 am
Easily add custom comments to Magento 2 orders programmatically using Order ID – for personalized guidance

SMB User
July 23, 2025, 7:11 am
Helpful tutorial on adding custom comments to Magento 2 orders—get advanced customization support from SMB Tech Solution for smoother development. Visit: https://smbtechsolution.com/magento-upgrade-services/

SMB User
July 31, 2025, 7:16 am
Great tutorial on adding custom order comments in Magento 2! For expert assistance and seamless implementation, consider reaching out to SMB Tech Solution. Visit: https://smbtechsolution.com/magento-upgrade-services/

SMB User
August 20, 2025, 8:20 am

Magento 2 Add custom comment programmatically to order with order id

People also searched for

Pingback:Magento Tech Digest #151 – Max Pronko

Leave a Reply Cancel Reply