Gamajo-Template-Loader 项目教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00035/article/details/138109667

Gamajo-Template-Loader 项目教程

Gamajo-Template-Loader A class to copy into your WordPress plugin, to allow loading template parts with fallback through the child theme > parent theme > plugin. 项目地址: https://gitcode.com/gh_mirrors/ga/Gamajo-Template-Loader

1、项目介绍

Gamajo-Template-Loader 是一个用于 WordPress 插件的开源项目，旨在简化插件中模板部分的加载过程，并支持从子主题到父主题再到插件的模板加载回退机制。通过使用这个类，开发者可以轻松地在插件中实现模板的加载，并允许主题开发者通过覆盖模板文件来自定义插件的外观。

项目地址: https://github.com/GaryJones/Gamajo-Template-Loader

2、项目快速启动

手动安装

下载 class-gamajo-template-loader.php 文件。
将该文件复制到你的 WordPress 插件目录中，可以放在插件根目录或 includes 目录下。

使用 Composer 安装

在你的项目根目录下运行以下命令，通过 Composer 安装 Gamajo-Template-Loader：
```
composer require gamajo/template-loader
```
推荐安装 Mozart 包以避免命名冲突：
```
composer require coenjacobs/mozart --dev
```
配置 Mozart 以重命名类名，防止与其他插件冲突。

实现自定义模板加载器

在你的插件目录中创建一个新的 PHP 文件，例如 class-your-plugin-template-loader.php。

在该文件中创建一个类，继承 Gamajo_Template_Loader（如果使用 Mozart，则继承重命名后的类）。

class Your_Plugin_Template_Loader extends Gamajo_Template_Loader {
    protected $filter_prefix = 'your_plugin';
    protected $theme_template_directory = 'your-plugin';
    protected $plugin_directory = YOUR_PLUGIN_DIR;
    protected $plugin_template_directory = 'templates';
}

在你的插件主文件中实例化并使用该类：

$template_loader = new Your_Plugin_Template_Loader();
$template_loader->get_template_part('template-name');

3、应用案例和最佳实践

应用案例

Easy Digital Downloads、WooCommerce 和 Events Calendar 等插件允许主题开发者通过添加自定义模板文件来覆盖默认模板。使用 Gamajo-Template-Loader 可以轻松实现类似的功能。

最佳实践

命名空间和前缀：使用 Mozart 或其他工具为类名添加前缀，以避免与其他插件的命名冲突。
模板目录结构：在插件中创建一个 templates 目录，并将所有模板文件放在该目录下。
数据传递：使用 set_template_data() 方法将数据传递给模板文件，以便在模板中使用。

4、典型生态项目

Cue 插件

Cue 是一个使用 Gamajo-Template-Loader 的典型项目。它通过在 vendor 目录中包含 Gamajo-Template-Loader 类，并在 class-cue-template-loader.php 文件中创建一个子类来实现模板加载。

项目地址: https://github.com/AudioTheme/cue

Meal Planner 插件

Meal Planner 是另一个使用 Gamajo-Template-Loader 的插件示例。它通过继承 Gamajo_Template_Loader 类并覆盖相关属性来实现自定义模板加载。

项目地址: https://github.com/GaryJones/Gamajo-Template-Loader