How to Delete Image or File in Magento 2

In Magento 2, it’s common for customers to upload images or files, such as product images, documents, or other media, through the front-end. As part of the file management process, it’s also essential to provide an option for customers to update or replace the files they’ve uploaded. When this happens, the previously uploaded images or files should be removed from the server to avoid clutter and unnecessary storage usage.

In this blog post, we will guide you on how to implement a functionality to delete images or files in Magento 2 when they are updated or replaced by the user.

Why Deleting Files is Important

When files or images are updated, leaving the old files on the server can cause several problems:

• Wasted Storage Space: Unused files will continue taking up server space.
• Performance Issues: Accumulation of unused files can slow down server performance.
• Cluttered File System: Without file deletion, your media directory can become disorganized and harder to manage.

How to Delete Images or Files in Magento 2

To properly manage uploaded files, you can use the following code snippet to delete any previously uploaded files when a new one is uploaded or updated.

Code Example to Delete Files in Magento 2:

<?php
namespace Codedecorator\Learn\Controller\Index;

use Magento\Backend\App\Action;
use Magento\Backend\App\Action\Context;
use Magento\Framework\Filesystem\Driver\File;
use Magento\Framework\Filesystem;
use Magento\Framework\App\Filesystem\DirectoryList;

class Delete extends Action
{

    protected $_filesystem;
    protected $_file;

    public function __construct(
        Context $context,
        Filesystem $_filesystem,
        File $file
    )
    {
        parent::__construct($context);
        $this->_filesystem = $_filesystem;
        $this->_file = $file;
    }

    public function execute()
    {
        ........
        $fileName = "file or image name";// replace this with some codes to get the $fileName
        $mediaRootDir = $this->_filesystem->getDirectoryRead(DirectoryList::MEDIA)->getAbsolutePath();
        if ($this->_file->isExists($mediaRootDir . $fileName)) {
            $this->_file->deleteFile($mediaRootDir . $fileName);
        }
       ......
    }
}

Conclusion:

By implementing this file deletion process, you ensure that your server does not accumulate unnecessary files, improving both server performance and file management. This approach provides a simple yet effective solution for managing image or file uploads in Magento 2.

If you face any issues or have further queries, feel free to reach out. We are here to help!

Let us know if you need any issues or any queries.

Happy Coding Guys!