Magento 2:在订单详情页添加自定义按钮及功能

magento 2:在订单详情页添加自定义按钮及功能

本文档详细介绍了如何在 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 文件中,注册我们的模块:

<?phpMagentoFrameworkComponentComponentRegistrar::register(    MagentoFrameworkComponentComponentRegistrar::MODULE,    'MG_Dropship',    __DIR__);

模块配置 (etc/module.xml)

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

    

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

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

             

这里我们使用 MagentoSalesBlockAdminhtmlOrderView 作为目标类型,并注册一个名为 addCustomButton 的插件,该插件指向我们的按钮插件类 MGDropshipPluginSalesBlockAdminhtmlOrderButton。

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

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

                                    

这定义了一个名为 mg_dropship 的路由,其前端名称(frontName)也是 mg_dropship。

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

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

logger = $logger;        parent::__construct(            $context,            $coreRegistry,            $fileFactory,            $dateFilter,            $orderSender,            $creditmemoSender,            $invoiceSender,            $shipmentSender,            $resultForwardFactory,            $resultPageFactory        );    }    /**     * 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 部分),最后重定向回订单查看页面。

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

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

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

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')}')"               ]            );        }    }}

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

权限控制 (acl.xml)

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

                                                                                                                                                

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

清理缓存和重新编译

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

php bin/magento cache:cleanphp bin/magento cache:flushphp bin/magento setup:upgradephp bin/magento setup:di:compilephp bin/magento setup:static-content:deploy -f

注意事项

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

总结

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

以上就是Magento 2:在订单详情页添加自定义按钮及功能的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1268481.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2025年12月10日 11:14:00
下一篇 2025年12月10日 11:14:11

相关推荐

发表回复

登录后才能评论
关注微信