本文档旨在指导开发者如何在 Magento 2 的后台订单详情页面添加一个自定义按钮，并在点击该按钮后执行特定的业务逻辑。我们将详细介绍模块的创建、配置、控制器编写以及插件的使用，确保按钮功能正常运作，并兼容 URL 安全密钥。
模块创建与配置
首先，我们需要创建一个自定义模块来实现该功能。按照 Magento 2 的模块开发规范，创建以下目录和文件：
-
注册模块 (registration.php)
在 app/code/MG/Dropship/registration.php 文件中注册模块：
<?php MagentoFrameworkComponentComponentRegistrar::register( MagentoFrameworkComponentComponentRegistrar::MODULE, 'MG_Dropship', __DIR__ );
-
模块声明 (module.xml)
在 app/code/MG/Dropship/etc/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>
修改 di.xml
在 app/code/MG/Dropship/etc/adminhtml/di.xml 中，我们使用插件（Plugin）来修改 MagentoSalesBlockAdminhtmlOrderView 块的行为，以便添加自定义按钮。
<?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="MagentoSalesBlockAdminhtmlOrderView"> <plugin name="addCustomButton" type="MGDropshipPluginSalesBlockAdminhtmlOrderButton"/> </type> </config>
配置路由 (routes.xml)
在 app/code/MG/Dropship/etc/adminhtml/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>
创建控制器 (Index.php)
在 app/code/MG/Dropship/Controller/AdminHtml/Order/Index.php 文件中创建控制器，用于处理按钮点击后的逻辑：
<?php namespace MGDropshipControllerAdminhtmlOrder; class Index extends MagentoSalesControllerAdminhtmlOrder { /** * @var PsrLogLoggerInterface */ protected $logger; /** * Index constructor. * * @param MagentoBackendAppActionContext $context * @param MagentoFrameworkRegistry $coreRegistry * @param MagentoFrameworkAppResponseHttpFileFactory $fileFactory * @param MagentoFrameworkStdlibDateTimeFilterDate $dateFilter * @param MagentoSalesModelOrderEmailSenderOrderSender $orderSender * @param MagentoSalesModelOrderEmailSenderCreditmemoSender $creditmemoSender * @param MagentoSalesModelOrderEmailSenderInvoiceSender $invoiceSender * @param MagentoSalesModelOrderEmailSenderShipmentSender $shipmentSender * @param MagentoFrameworkViewResultPageFactory $resultPageFactory * @param MagentoFrameworkViewResultLayoutFactory $resultLayoutFactory * @param MagentoFrameworkControllerResultRawFactory $resultRawFactory * @param MagentoFrameworkControllerResultJsonFactory $resultJsonFactory * @param MagentoFrameworkMessageManagerInterface $messageManager * @param PsrLogLoggerInterface $logger */ public function __construct( MagentoBackendAppActionContext $context, MagentoFrameworkRegistry $coreRegistry, MagentoFrameworkAppResponseHttpFileFactory $fileFactory, MagentoFrameworkStdlibDateTimeFilterDate $dateFilter, MagentoSalesModelOrderEmailSenderOrderSender $orderSender, MagentoSalesModelOrderEmailSenderCreditmemoSender $creditmemoSender, MagentoSalesModelOrderEmailSenderInvoiceSender $invoiceSender, MagentoSalesModelOrderEmailSenderShipmentSender $shipmentSender, MagentoFrameworkViewResultPageFactory $resultPageFactory, MagentoFrameworkViewResultLayoutFactory $resultLayoutFactory, MagentoFrameworkControllerResultRawFactory $resultRawFactory, MagentoFrameworkControllerResultJsonFactory $resultJsonFactory, MagentoFrameworkMessageManagerInterface $messageManager, PsrLogLoggerInterface $logger ) { $this->logger = $logger; parent::__construct( $context, $coreRegistry, $fileFactory, $dateFilter, $orderSender, $creditmemoSender, $invoiceSender, $shipmentSender, $resultPageFactory, $resultLayoutFactory, $resultRawFactory, $resultJsonFactory, $messageManager ); } /** * Execute action * * @throws MagentoFrameworkExceptionLocalizedException|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 (MagentoFrameworkExceptionLocalizedException $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'); } }
此控制器继承自 MagentoSalesControllerAdminhtmlOrder，并重写了 execute() 方法。在该方法中，首先初始化订单，然后执行自定义逻辑（TODO 部分），最后重定向回订单详情页。
注意：
- 请务必替换 // TODO: Do something with the order 部分，实现你的具体业务逻辑。
- _isAllowed() 方法用于权限控制，确保只有具有 MG_Dropship::order_dosomething 权限的用户才能访问该功能。
创建插件 (Button.php)
在 app/code/MG/Dropship/Plugin/Sales/Block/Adminhtml/Order/Button.php 文件中创建插件，用于向订单详情页添加按钮：
<?php namespace MGDropshipPluginSalesBlockAdminhtmlOrder; use MagentoSalesBlockAdminhtmlOrderView; class Button { public function beforeSetLayout(View $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')}')" ] ); } } }
此插件使用 beforeSetLayout 方法，在布局渲染之前向 MagentoSalesBlockAdminhtmlOrderView 块添加一个名为 do_something 的按钮。
- label: 按钮上显示的文本。
- class: 按钮的 css 类，可以自定义样式。
- onclick: 按钮点击时执行的 JavaScript 代码，这里使用 confirmSetLocation 函数显示一个确认对话框，然后重定向到 mg_dropship/order/index 路由。
清理缓存并更新模块
完成以上步骤后，需要清理 Magento 2 的缓存并更新模块：
- 执行 php bin/magento setup:upgrade 命令。
- 执行 php bin/magento setup:di:compile 命令。
- 执行 php bin/magento setup:Static-content:deploy -f 命令。
- 执行 php bin/magento cache:clean 命令。
- 执行 php bin/magento cache:flush 命令。
总结
通过以上步骤，我们成功地向 Magento 2 的后台订单详情页添加了一个自定义按钮，并在点击该按钮后执行了特定的业务逻辑。 此方案兼容 URL 安全密钥，确保了链接的安全性。 在实际开发中，你需要根据具体的业务需求修改控制器中的逻辑和按钮的样式。
© 版权声明
文章版权归作者所有，未经允许请勿转载。
THE END
