Overriding Magento Admin Controller, for Beginners

Overriding Magento Admin Controller, for Beginners

July 10, 2026 · Illustrated author avatarBy Stefan Bogdanescu
Overriding Magento Admin Controller, for Beginners

Overriding Magento Admin Controller: A Comprehensive Guide for Beginners

Magento is a powerful e-commerce platform that allows you to create stunning online stores quickly and easily. However, sometimes you may need to override the core functionality of the admin section to fit your specific business needs.

Understanding Magento Controllers

In Magento, controllers are responsible for processing requests from both the frontend (customer-facing) and backend (admin) sections. They handle user interactions by executing actions and calling models, blocks, or other resources.

The file you’re trying to override—Sales/Order/ShipmentController.php—is part of the core Sales module. It handles shipment-related operations in the admin panel, such as creating new shipments for orders.

Overriding a Magento Admin Controller

To override an admin controller in Magento, we’ll use the concept of rewriting. This involves defining a custom module that “replaces” the core functionality with your custom code.

Here’s a step-by-step guide:

  1. Create a Custom Module: Create a folder for your new module under app/code/Vendor/YourModule. Replace Vendor and YourModule with your actual vendor name and desired module name, respectively.

  2. Include the Required Files: Inside the app/code/Vendor/YourModule/etc directory, create two files—module.xml and config.xml.

  3. Configure Your Module: In module.xml, define basic information about your module:

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
    <module name="Vendor_YourModule" setup_version="1.0.0"/>
</config>
  1. Setup Rewriting: In config.xml, define the rewrites for your admin controller:
<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Config/etc/config.xsd">
    <adminhtml>
        <layout>
            <updates>
                <your_module>
                    <file>your_module.xml</file>
                </your_module>
            </updates>
        </layout>
    </adminhtml>
</config>
  1. Create the Rewrite File: Inside app/code/Vendor/YourModule/view/adminhtml/layout, create a file called your_module.xml.

  2. Define the Rewrite: In this file, define your rewrite for the shipment controller:

<?xml version="1.0"?>
<layout xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/layouts.xsd">
    <update handle="sales_order_shipment_index"/>
</layout>
  1. Create Your Custom Controller: Inside app/code/Vendor/YourModule/Controller/Adminhtml/Sales/Order, create a file called ShipmentController.php.

  2. Write Your Custom Logic: In this file, inherit from the core controller and write your custom logic.

The Purpose of the Shipment Controller

The Sales/Order/ShipmentController.php file in Magento is responsible for handling all shipment-related operations in the admin panel. It provides functionality to create new shipments, update existing ones, and view shipment details.

For example, if a store owner wants to send an item to a customer, they would use this controller to create a new shipment record and generate shipping labels or packing slips.

Conclusion

Overriding Magento admin controllers is a powerful way to customize the platform’s behavior. By following the steps outlined above, you can create custom functionality that enhances your store’s operations without modifying the core codebase.

Remember, when working with overrides, always ensure you follow Magento’s coding standards and best practices. This includes keeping your changes separate from the core files so they don’t get overwritten during updates.

For more advanced techniques in Magento development, consider checking out LaravelCompany.com, where we provide comprehensive guides on Magento optimization, performance tuning, and custom extension development.

Extensions Admin Configuration Orders

Our network