本文档详细介绍了如何在 Magento 2 后台的订单详情页面添加一个自定义按钮，并在点击该按钮后执行自定义功能。我们将创建一个简单的模块，该模块将在订单查看页面添加一个“Do Something”按钮，点击后会触发一个控制器，该控制器可以执行任何你想要的操作，例如更新订单状态、发送邮件等。本文档将提供完整的代码示例和配置说明，帮助你快速实现此功能。

创建模块

首先，我们需要创建一个 Magento 2 模块。按照 Magento 的标准模块结构，创建以下目录和文件：

app/code/MG/Dropship/
├── Controller
│   └── Adminhtml
│       └── Order
│           └── Index.php
├── Plugin
│   └── Sales
│       └── Block
│           └── Adminhtml
│               └── Order
│                   └── Button.php
├── etc
│   ├── adminhtml
│   │   ├── di.xml
│   │   └── routes.xml
│   └── module.xml
└── registration.php

注册模块 (registration.php)

在 registration.php 文件中，注册我们的模块：

<?php
\Magento\Framework\Component\ComponentRegistrar::register(
    \Magento\Framework\Component\ComponentRegistrar::MODULE,
    'MG_Dropship',
    __DIR__
);

模块配置 (etc/module.xml)

在 module.xml 文件中，定义模块的基本信息：

<?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="MG_Dropship" setup_version="1.0.0"/>
</config>

依赖注入配置 (etc/adminhtml/di.xml)

di.xml 文件用于配置依赖注入，我们将使用插件（Plugin）来修改订单查看页面。

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
   <type name="Magento\Sales\Block\Adminhtml\Order\View">
       <plugin name="addCustomButton" type="MG\Dropship\Plugin\Sales\Block\Adminhtml\Order\Button"/>
   </type>
</config>

这里我们使用 Magento\Sales\Block\Adminhtml\Order\View 作为目标类型，并注册一个名为 addCustomButton 的插件，该插件指向我们的按钮插件类 MG\Dropship\Plugin\Sales\Block\Adminhtml\Order\Button。

路由配置 (etc/adminhtml/routes.xml)

routes.xml 文件用于定义后台路由。

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:App/etc/routes.xsd">
    <router id="admin">
        <route id="mg_dropship" frontName="mg_dropship">
            <module name="MG_Dropship" />
        </route>
    </router>
</config>

这定义了一个名为 mg_dropship 的路由，其前端名称（frontName）也是 mg_dropship。

控制器 (Controller/Adminhtml/Order/Index.php)

Index.php 文件是我们的控制器，用于处理按钮点击后的逻辑。

CSS婚礼策划服务机构宣传网站模板

CSS婚礼策划服务机构宣传网站模板是一款适合提供婚礼策划和婚庆服务机构宣传网站模板下载。提示：本模板调用到谷歌字体库，可能会出现页面打开比较缓慢。

下载

<?php
namespace MG\Dropship\Controller\Adminhtml\Order;

class Index extends \Magento\Sales\Controller\Adminhtml\Order
{
    /**
     * @var \Psr\Log\LoggerInterface
     */
    protected $logger;

    /**
     * Index constructor.
     *
     * @param \Magento\Backend\App\Action\Context $context
     * @param \Magento\Framework\Registry $coreRegistry
     * @param \Magento\Framework\App\Response\Http\FileFactory $fileFactory
     * @param \Magento\Framework\Stdlib\DateTime\Filter\Date $dateFilter
     * @param \Magento\Sales\Model\Order\Email\Sender\OrderSender $orderSender
     * @param \Magento\Sales\Model\Order\Email\Sender\CreditmemoSender $creditmemoSender
     * @param \Magento\Sales\Model\Order\Email\Sender\InvoiceSender $invoiceSender
     * @param \Magento\Sales\Model\Order\Email\Sender\ShipmentSender $shipmentSender
     * @param \Magento\Framework\View\Result\ForwardFactory $resultForwardFactory
     * @param \Magento\Framework\View\Result\PageFactory $resultPageFactory
     * @param \Psr\Log\LoggerInterface $logger
     */
    public function __construct(
        \Magento\Backend\App\Action\Context $context,
        \Magento\Framework\Registry $coreRegistry,
        \Magento\Framework\App\Response\Http\FileFactory $fileFactory,
        \Magento\Framework\Stdlib\DateTime\Filter\Date $dateFilter,
        \Magento\Sales\Model\Order\Email\Sender\OrderSender $orderSender,
        \Magento\Sales\Model\Order\Email\Sender\CreditmemoSender $creditmemoSender,
        \Magento\Sales\Model\Order\Email\Sender\InvoiceSender $invoiceSender,
        \Magento\Sales\Model\Order\Email\Sender\ShipmentSender $shipmentSender,
        \Magento\Framework\View\Result\ForwardFactory $resultForwardFactory,
        \Magento\Framework\View\Result\PageFactory $resultPageFactory,
        \Psr\Log\LoggerInterface $logger
    ) {
        $this->logger = $logger;
        parent::__construct(
            $context,
            $coreRegistry,
            $fileFactory,
            $dateFilter,
            $orderSender,
            $creditmemoSender,
            $invoiceSender,
            $shipmentSender,
            $resultForwardFactory,
            $resultPageFactory
        );
    }
    /**
     * Execute action
     *
     * @throws \Magento\Framework\Exception\LocalizedException|\Exception
     */
    public function execute()
    {
        // In case you want to do something with the order
        $order = $this->_initOrder();
        if ($order) {
            try {
                // TODO: Do something with the order
                $this->messageManager->addSuccessMessage(__('We did something!'));
            } catch (\Magento\Framework\Exception\LocalizedException $e) {
                $this->messageManager->addErrorMessage($e->getMessage());
            } catch (\Exception $e) {
                $this->messageManager->addErrorMessage(__('We can\'t process your request' . $e->getMessage()));
                $this->logger->critical($e);
            }

            return $this->resultRedirectFactory->create()->setPath(
                'sales/order/view',
                [
                   'order_id' => $order->getEntityId()
                ]
             );  
          }

        return $this->resultRedirectFactory->create()->setPath('sales/*/');
    }

    /**
     * @return bool
     */
    protected function _isAllowed()
    {
        return $this->_authorization->isAllowed('MG_Dropship::order_dosomething');
    }
}

这个控制器继承自 \Magento\Sales\Controller\Adminhtml\Order，并重写了 execute 方法。在这个方法中，我们首先初始化订单，然后执行自定义逻辑（TODO 部分），最后重定向回订单查看页面。

_isAllowed 方法用于权限控制，你需要定义相应的 ACL 规则。

按钮插件 (Plugin/Sales/Block/Adminhtml/Order/Button.php)

Button.php 文件是我们的插件，用于在订单查看页面添加自定义按钮。

<?php
namespace MG\Dropship\Plugin\Sales\Block\Adminhtml\Order;

use Magento\Sales\Block\Adminhtml\Order\View as OrderView;

class Button
{
    public function beforeSetLayout(OrderView $subject)
    {
        if ($subject->getOrder()) {
            $message = __('Are you sure you want to Do Something?');
            $subject->addButton(
                'do_something',
                [
               'label' => __('Do Something'),
               'class' => 'do_something',
               'onclick' => "confirmSetLocation('{$message}', '{$subject->getUrl('mg_dropship/order/index')}')"
               ]
            );
        }
    }
}

这个插件拦截了 Magento\Sales\Block\Adminhtml\Order\View 类的 setLayout 方法，并在该方法执行之前添加了一个自定义按钮。addButton 方法用于添加按钮，参数包括按钮 ID、按钮属性（标签、CSS 类、点击事件等）。 confirmSetLocation 会显示一个确认框，用户点击确认后才会跳转到指定的 URL。

权限控制 (acl.xml)

为了控制用户是否可以访问我们的自定义功能，我们需要在 etc/adminhtml/acl.xml 文件中定义 ACL 规则。

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Acl/etc/acl.xsd">
    <acl>
        <resources>
            <resource id="Magento_Backend::admin">
                <resource id="Magento_Sales::sales">
                    <resource id="Magento_Sales::orders">
                        <resource id="MG_Dropship::order_dosomething" title="Do Something" sortOrder="10" />
                    </resource>
                </resource>
            </resource>
        </resources>
    </acl>
</config>

这个文件定义了一个名为 MG_Dropship::order_dosomething 的权限，你需要在后台用户角色管理中为相应的角色分配这个权限。

清理缓存和重新编译

完成以上步骤后，你需要清理 Magento 2 的缓存并重新编译代码：

php bin/magento cache:clean
php bin/magento cache:flush
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy -f

注意事项

• 确保你的模块已经启用。
• 在控制器中实现你的自定义逻辑。
• 根据你的需求修改 ACL 规则。
• 在生产环境中，确保启用 URL 密钥（Add Secret Key to URLs）。

总结

通过以上步骤，你就可以在 Magento 2 后台的订单详情页面添加一个自定义按钮，并在点击该按钮后执行自定义功能。这为你提供了很大的灵活性，可以根据你的业务需求定制 Magento 2 的后台功能。记住，良好的代码结构和清晰的逻辑是关键，这将使你的代码更易于维护和扩展。