How to add custom button on admin order view page in Magento2?

To add a custom button on the admin order view page, you need to create a before plugin for the PushButtons() method from the Magento\Backend\Block\Widget\Button\Toolbar class.

Create di.xml file under the adminhtml scope,
Path: app/code/Magemonkeys/OrderViewButton/etc/adminhtml/di.xml

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
    <!-- Add new Button on sales order view toolbar -->
    <type name="Magento\Backend\Block\Widget\Button\Toolbar">
        <plugin name="add_sales_button_toolbar" type="Magemonkeys\OrderViewButton\Plugin\Block\Widget\Button\ToolbarPlugin" />
    </type>
</config>

<?xml version="1.0"?>

<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">

</type>

</config>

create ToolbarPlugin.php
Path: app/code/Magemonkeys/OrderViewButton/Plugin/Block/Widget/Button/ToolbarPlugin.php

<?php declare(strict_types=1);

namespace Magemonkeys\OrderViewButton\Plugin\Block\Widget\Button;

use Magento\Sales\Block\Adminhtml\Order\Create;
use Magento\Framework\View\Element\AbstractBlock;
use Magento\Backend\Block\Widget\Button\ButtonList;
use Magento\Backend\Block\Widget\Button\Toolbar as ToolbarContext;

class ToolbarPlugin
{
    /**
     * @param ToolbarContext $toolbar
     * @param AbstractBlock $context
     * @param ButtonList $buttonList
     * @return array
     */
    public function beforePushButtons(
        ToolbarContext $toolbar,
        AbstractBlock $context,
        ButtonList $buttonList
    ): array {
        $order = false;
        $nameInLayout = $context->getNameInLayout();
        if ('sales_order_edit' == $nameInLayout) {
            $order = $context->getOrder();
        }

        if ($order) {
        	$url = "YOUR_URL"; // add your full url
	        $buttonList->add(
	            'my_button',
	            [
	                'label' => __('My Button'),
	            	'on_click' => sprintf("location.href = '%s';", $url),
	                'class' => 'primary',
	                'id' => 'my_button'
	            ]
	        );
        }

        return [$context, $buttonList];        
    }
}<code>

<?php declare(strict_types=1);

namespace Magemonkeys\OrderViewButton\Plugin\Block\Widget\Button;

use Magento\Sales\Block\Adminhtml\Order\Create;

use Magento\Framework\View\Element\AbstractBlock;

use Magento\Backend\Block\Widget\Button\ButtonList;

use Magento\Backend\Block\Widget\Button\Toolbar as ToolbarContext;

class ToolbarPlugin

{

/**

* @param ToolbarContext $toolbar

* @param AbstractBlock $context

* @param ButtonList $buttonList

* @return array

public function beforePushButtons(

ToolbarContext $toolbar,

AbstractBlock $context,

ButtonList $buttonList

): array {

$order = false;

$nameInLayout = $context->getNameInLayout();

if ('sales_order_edit' == $nameInLayout) {

$order = $context->getOrder();

}

if ($order) {

$url = "YOUR_URL"; // add your full url

$buttonList->add(

'my_button',

[

'label' => __('My Button'),

'on_click' => sprintf("location.href = '%s';", $url),

'class' => 'primary',

'id' => 'my_button'

]

);

}

return [$context, $buttonList];

}

}<code>

Output :

Fill the below form if you have any Magento programming need.

Add an image programmatically from any url in Magento 2
[crayon-64216e2c68159796849537/] Using above fucntion Images can be imported directly from...
Magento 2 : Override the Category view block file
Override view block using di.xml and add the below code...
How to check list of Layout XML called for a specific page in Magento 2?
You can check a list of called layout XML for...
Magento 2 : Setup PWA from Scratch
Follow the below steps to install and set up PWA...
How to remove leading zero’s from the order, invoice and shipment number in Magento 2?
If you want to remove all leading zero's from order,...

Author Info

Magento Certified Developer

Hire J. Lakum

Let’s have a call

Fill the form & Get Installation Support