How to Remove a Specific Order Status Comment in Magento 2++

In Magento 2, order status comments help track order progress. Sometimes, you might need to delete a specific comment to keep the order history clean. Here's how to do it:

Using a Custom PHP Script

• Create the Script: In your Magento root directory, create a file named DeleteOrderStatusComment.php.
• Add the Code: Insert the following code into the file:

<?php

use Magento\Framework\App\Bootstrap;

require __DIR__ . '/app/bootstrap.php';

$bootstrap = Bootstrap::create(BP, $_SERVER);

$objectManager = $bootstrap->getObjectManager();

$state = $objectManager->get('Magento\Framework\App\State');

$state->setAreaCode('frontend');

try {

$orderID = 71; // Replace with the desired order ID

$commentID = 22; // Replace with the desired comment ID

$order = $objectManager->create('Magento\Sales\Model\Order')->load($orderID);

$commentsCollection = $order->getStatusHistoryCollection();

foreach ($commentsCollection as $comment) {

if ($comment->getId() == $commentID) {

$comment->delete();

break;

}

}

$order->save();

echo 'Order status comment deleted successfully!';

} catch (\Exception $e) {

echo "Error: " . $e->getMessage();

}

• Run the Script: Execute this script from the command line or through a browser to remove the specified comment.

Using Magento's API

Alternatively, you can use Magento's API to delete a comment:

• Load the Comment: Retrieve the comment by its ID.
• Delete the Comment: Use the delete method from the OrderStatusHistoryRepositoryInterface to remove the comment..

namespace YourNamespace\DeleteStatusComment\Model;

use Magento\Sales\Api\OrderStatusHistoryRepositoryInterface;

use Psr\Log\LoggerInterface;

class DeleteStatusComment

{

private $orderStatusRepository;

private $logger;

public function __construct(

OrderStatusHistoryRepositoryInterface $orderStatusRepository,

LoggerInterface $logger

) {

$this->orderStatusRepository = $orderStatusRepository;

$this->logger = $logger;

}

public function removeStatusFromOrder(int $commentId)

{

try {

$orderStatusCommentObject = $this->orderStatusRepository->get($commentId);

$this->orderStatusRepository->delete($orderStatusCommentObject);

return true;

} catch (\Exception $exception) {

$this->logger->error($exception->getMessage());

return false;

}

}

}

'; ?>

• Call the Method: Invoke the removeStatusFromOrder method with the comment ID to delete the comment.

By following these steps, you can effectively remove specific order status comments in Magento 2, keeping your order history organized.

namespace YourNamespace\DeleteOrderStatusComment\Model;

use Magento\Sales\Api\OrderStatusHistoryRepositoryInterface;
use Magento\Sales\Api\Data\OrderStatusHistoryInterface;
use Psr\Log\LoggerInterface;

class DeleteStatusComment
{
    private $orderStatusRepository;
    private $logger;

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

    public function removeStatusFromOrder(int $commentId)
    {
        try {
            $orderStatusCommentObject = $this->orderStatusRepository->get($commentId);
            $this->orderStatusRepository->delete($orderStatusCommentObject);
            return true;
        } catch (\Exception $exception) {
            $this->logger->error($exception->getMessage());
            return false;
        }
    }
}