0

0

Magento 2:在PHTML或块文件中直接调用模板文件

DDD

DDD

发布时间:2025-10-30 11:53:12

|

320人浏览过

|

来源于php中文网

原创

Magento 2:在PHTML或块文件中直接调用模板文件

本文将介绍在magento 2中,如何在不依赖布局xml文件的情况下,直接从phtml模板文件或php块文件中加载并渲染另一个phtml模板。我们将探讨两种主要方法:利用`$this->getlayout()->createblock()`在phtml中调用,以及使用`objectmanager`在php块文件中实现,并强调每种方法的适用场景及最佳实践。

在Magento 2的开发中,通常我们通过布局XML文件来定义块和模板的结构,从而实现页面的渲染。然而,在某些特定场景下,例如需要动态加载某个模板片段、在现有PHTML文件内部插入一个不属于当前布局层级的独立组件,或者在PHP逻辑中根据条件渲染不同的模板时,直接在PHTML文件或PHP块文件中调用另一个模板文件会更加灵活和高效。本文将详细阐述这两种直接调用模板的方法。

一、在PHTML文件中直接调用模板

当您在一个PHTML模板文件内部需要渲染另一个独立的PHTML模板片段时,可以使用当前模板的布局对象来创建并渲染新的块。这种方法是Magento推荐的,因为它利用了Magento的布局系统,且不直接依赖ObjectManager。

示例代码:

getLayout()
          ->createBlock(\Magento\Framework\View\Element\Template::class)
          ->setTemplate('Vendor_Module::template.phtml')
          ->toHtml();
?>

代码解析:

DM6在线读报系统
DM6在线读报系统

DM6在线读报系统ASPX 免费版2.0。如果您是一个DM广告公司的网站管理员,正在寻求一套程序或源码可以让公司网站具有一套配合网站整体架构的电子杂志频道,那您现在可找对了。请仔细阅读以下关于DM6在线读报系统的说明。 这是一个网站用户可以直接在线阅读报纸且无需插件(连Flash都不用)、无需下载、无需安装的在线读报系统(服务器端模块),通过将此系统放到网站文件目录中即可轻松生成网站的在线读报频道

下载

立即学习前端免费学习笔记(深入)”;

  1. $this->getLayout():在PHTML模板文件中,$this通常代表当前模板对应的块实例。通过它,我们可以访问到当前的布局对象。
  2. createBlock(\Magento\Framework\View\Element\Template::class):这是核心步骤,它指示布局对象创建一个新的块实例。我们指定创建的块类型是\Magento\Framework\View\Element\Template,这是一个通用的模板块,用于渲染PHTML文件。
  3. setTemplate('Vendor_Module::template.phtml'):设置新创建块要渲染的PHTML模板路径。这里的Vendor_Module是您的模块名称,template.phtml是位于该模块view/frontend/templates/(或view/adminhtml/templates/)目录下的模板文件。
  4. toHtml():调用此方法来渲染指定的模板,并返回其HTML输出。

适用场景与优势:

  • 动态内容插入: 根据PHTML中的业务逻辑,动态决定是否渲染或渲染哪个子模板。
  • 组件化复用: 将可复用的UI组件封装在独立的PHTML文件中,并在需要的地方直接引用。
  • 遵循Magento规范: 这种方法通过布局对象创建块,符合Magento的架构设计,避免了直接使用ObjectManager。

二、在PHP块文件中直接调用模板

有时,您可能需要在PHP块文件(或任何其他PHP类)中,根据业务逻辑来渲染一个PHTML模板并获取其HTML内容。尽管Magento 2强烈推荐通过依赖注入(DI)来获取和使用服务,但以下示例展示了如何通过ObjectManager直接创建模板实例。

示例代码:

create(\Magento\Framework\View\Element\Template::class);
        $templateBlock->setTemplate('Vendor_Module::another_template.phtml');

        return $templateBlock->toHtml();
    }
}

代码解析:

立即学习前端免费学习笔记(深入)”;

  1. $objectManager = \Magento\Framework\App\ObjectManager::getInstance();:获取Magento的ObjectManager实例。
  2. $objectManager->create(\Magento\Framework\View\Element\Template::class);:使用ObjectManager创建一个\Magento\Framework\View\Element\Template类的实例。
  3. $templateBlock->setTemplate('Vendor_Module::another_template.phtml');:设置要渲染的PHTML模板路径。
  4. return $templateBlock->toHtml();:渲染模板并返回其HTML内容。

重要提示:关于ObjectManager的使用

直接在代码中调用\Magento\Framework\App\ObjectManager::getInstance()来获取ObjectManager并创建对象,在Magento 2中是强烈不推荐的。这种做法违反了依赖注入(Dependency Injection, DI)的设计原则,导致代码难以测试、维护和扩展。

推荐的替代方案:

在PHP块文件或其他类中,您应该通过构造函数依赖注入来获取所需的工厂或类实例。例如,如果您需要创建模板块,可以注入\Magento\Framework\View\Element\BlockFactory或更具体的\Magento\Framework\View\Element\TemplateFactory:

blockFactory = $blockFactory;
        parent::__construct($context, $data);
    }

    public function getCustomTemplateContentProperly()
    {
        /** @var Template $templateBlock */
        $templateBlock = $this->blockFactory->createBlock(Template::class);
        $templateBlock->setTemplate('Vendor_Module::another_template.phtml');

        return $templateBlock->toHtml();
    }
}

通过这种方式,YourBlock类不再直接依赖ObjectManager,而是通过构造函数接收它所需的BlockFactory实例,从而遵循了Magento 2的DI最佳实践。

三、最佳实践与注意事项

  1. 优先使用布局XML: 对于大多数结构性的页面元素和组件,布局XML仍然是Magento 2中管理块和模板的首选方式。它提供了清晰的结构定义、易于扩展和维护。
  2. 理解使用场景: 直接调用模板适用于动态内容、局部组件渲染以及需要绕过布局XML进行灵活控制的特定场景。
  3. 避免滥用: 频繁或不恰当地直接调用模板可能会使页面结构变得复杂,难以追踪和调试。
  4. 性能考量: 每次createBlock都会实例化一个新的块对象。虽然通常性能影响不大,但在循环中大量创建则需谨慎。
  5. 遵循DI原则: 在PHP类中,务必通过依赖注入来获取所需的类实例,而不是直接使用ObjectManager。

总结

Magento 2提供了灵活的方式来管理模板渲染。无论是通过PHTML文件中的$this->getLayout()->createBlock(),还是在PHP块文件中(推荐通过依赖注入的工厂)动态创建和渲染模板,开发者都可以根据具体需求选择最合适的方法。理解每种方法的优缺点和适用场景,并遵循Magento 2的开发规范,将有助于构建健壮、可维护的应用程序。

相关专题

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

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

2890

2023.09.01

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

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

1731

2023.10.11

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

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

1564

2023.10.11

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

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

1099

2023.10.23

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

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

1546

2023.10.23

html怎么上传
html怎么上传

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

1277

2023.11.03

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

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

1649

2023.11.09

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

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

1309

2023.11.13

c++ 根号
c++ 根号

本专题整合了c++根号相关教程,阅读专题下面的文章了解更多详细内容。

70

2026.01.23

热门下载

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

精品课程

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

共137课时 | 9.4万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 11.1万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

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

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