0

0

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

聖光之護

聖光之護

发布时间:2025-08-08 16:24:30

|

909人浏览过

|

来源于php中文网

原创

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 文件中,注册我们的模块:

模块配置 (etc/module.xml)

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



    

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

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



   
       
   

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

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

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



    
        
            
        
    

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

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

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

一步半YBB企业网站管理系统1.2
一步半YBB企业网站管理系统1.2

一步半YBB企业网站管理系统功能介绍: 1) 系统管理:管理员管理,网站配置,上传文件管理,QQ-MSN-旺旺 在线客服设置,文件浏览,公告管理,首页幻灯,友情链接,调查管理,导航栏目。 2) 企业信息:后台自由添加修改企业的各类信息及介绍。 3) 产品管理:产品类别新增修改管理,产品添加修改以及产品的审核。 4) 订单管理:查看订单的详细信息及订单处理。 5) 会员管理:查看修改删除会员资料,及

下载
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 文件是我们的插件,用于在订单查看页面添加自定义按钮。

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 规则。



    
        
            
                
                    
                        
                    
                
            
        
    

这个文件定义了一个名为 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 的后台功能。记住,良好的代码结构和清晰的逻辑是关键,这将使你的代码更易于维护和扩展。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2491

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1595

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1487

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

952

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1414

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1234

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1445

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1306

2023.11.13

Java 桌面应用开发(JavaFX 实战)
Java 桌面应用开发(JavaFX 实战)

本专题系统讲解 Java 在桌面应用开发领域的实战应用,重点围绕 JavaFX 框架,涵盖界面布局、控件使用、事件处理、FXML、样式美化(CSS)、多线程与UI响应优化,以及桌面应用的打包与发布。通过完整示例项目,帮助学习者掌握 使用 Java 构建现代化、跨平台桌面应用程序的核心能力。

9

2026.01.14

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Sass 教程
Sass 教程

共14课时 | 0.8万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.9万人学习

CSS教程
CSS教程

共754课时 | 18.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号