README

Merlin WP旨在解决繁琐而耗时的WordPress主题设置和安装过程。它使安装新的WordPress主题、推荐的WordPress插件、自定义设置、小工具和演示内容成为一个令人兴奋且令人满意的用户体验。了解更多...

beta & 测试

Merlin WP目前处于beta测试阶段，不建议在生产环境中使用Merlin WP，因为还有一些bug和功能需要添加。如果您遇到任何问题，请提出问题，让我们共同解决。

使用方法

1. 将Merlin WP添加到您的WordPress主题

首先，从Merlin WP的GitHub仓库中下载最新版本。接下来，将版本中的所有文件添加到您的主题中。

现在您需要做的就是将class-merlin.php类、merlin-config.php和composer自动加载文件包含在您的functions.php文件中，如下所示

require_once get_parent_theme_file_path( '/inc/merlin/vendor/autoload.php' );
require_once get_parent_theme_file_path( '/inc/merlin/class-merlin.php' );
require_once get_parent_theme_file_path( '/inc/merlin-config.php' );

在上面的例子中，/merlin/目录和merlin-config.php文件都放置在主题的/inc/目录位置。另外，如果您在主题中包含了TGMPA，请确保在它之后包含Merlin WP。

2. 配置Merlin WP

merlin-config.php文件告诉Merlin WP类安装的位置。在此配置文件中，您还可以启用Easy Digital Downloads软件许可证激活步骤。

配置文件还可以让您修改任何文本字符串。

directory — 在您的主题中放置merlin代码目录的位置（例如：inc/merlin，如果您将merlin文件夹放置在主题的inc文件夹中）
merlin_url — Merlin WP存在的管理url别名
child_action_btn_url — 子主题生成器“了解更多”链接的url
dev_mode — 在WordPress管理 > 外观部分保留“主题设置”菜单项以进行测试
license_step — 打开许可证激活（与Easy Digital Downloads软件许可证兼容）
license_help_url — 关于许可证的自定义帮助链接
edd_item_name — EDD项目名称，必须与EDD_Theme_Updater_Admin类中的配置参数中的item_name相同
edd_theme_slug — EDD别名，必须与EDD_Theme_Updater_Admin类中的配置参数中的theme_slug相同
edd_remote_api_url — EDD远程API URL，必须与EDD_Theme_Updater_Admin类中的配置参数中的remote_api_url相同

3. 定义您的演示内容导入文件

您需要以下文件

content.xml — 使用WordPress导出器导出的演示内容
widgets.wie — 使用小工具导入导出器导出的小工具
customizer.dat — 使用自定义设置导出/导入导出的自定义设置

一旦您有了这些文件，您可以将它们上传到您的服务器（推荐），或者将它们包含在您的主题中的某个位置。接下来，定义一个过滤器，让WP Merlin知道这些文件的位置。根据您放置导入文件的位置，您有两种定义过滤器的方法

1. 如果您将导入文件上传到您的服务器，那么请使用以下代码示例并对其进行编辑，以适应您的文件位置

function merlin_import_files() {
	return array(
		array(
			'import_file_name'           => 'Demo Import',
			'import_file_url'            => 'http://www.your_domain.com/merlin/demo-content.xml',
			'import_widget_file_url'     => 'http://www.your_domain.com/merlin/widgets.json',
			'import_customizer_file_url' => 'http://www.your_domain.com/merlin/customizer.dat',
			'import_preview_image_url'   => 'http://www.your_domain.com/merlin/preview_import_image1.jpg',
			'import_notice'              => __( 'A special note for this import.', 'your-textdomain' ),
			'preview_url'                => 'http://www.your_domain.com/my-demo-1',
		),
	);
}
add_filter( 'merlin_import_files', 'merlin_import_files' );

2. 如果您在主题中包含了一些导入文件，那么请使用以下代码示例

function merlin_local_import_files() {
	return array(
		array(
			'import_file_name'             => 'Demo Import',
			'local_import_file'            => get_parent_theme_file_path( '/inc/demo/content.xml' ),
			'local_import_widget_file'     => get_parent_theme_file_path( '/inc/demo/widgets.wie' ),
			'local_import_customizer_file' => get_parent_theme_file_path( '/inc/demo/customizer.dat' ),
			'import_preview_image_url'     => 'http://www.your_domain.com/merlin/preview_import_image1.jpg',
			'import_notice'                => __( 'A special note for this import.', 'your-textdomain' ),
			'preview_url'                  => 'http://www.your_domain.com/my-demo-1',
		),
	);
}
add_filter( 'merlin_import_files', 'merlin_local_import_files' );

多个示例导入

如果您有多个示例导入，则只需定义多个包含适当数据的数组。以下是一个示例，展示了如何定义两个预定义的示例导入，请参考 merlin-filters-sample.php 文件。

Redux 框架导入

如果您在主题中使用 Redux 框架，那么您也可以导入它。请参考 merlin-filters-sample.php 文件，了解如何定义 Redux 导入文件。

4. Easy Digital Downloads 软件许可激活

您需要在设置向导中使用 EDD 和 EDD 软件许可插件来部署此步骤。默认情况下此步骤是禁用的，因此您需要在 merlin-config.php 文件中启用它（请参考上面的 配置 Merlin WP 步骤）。

一旦在 merlin-config.php 文件中配置了所有必要的设置，许可激活步骤将显示在子主题步骤之后。

此集成适用于 EDD 许可主题示例，您也可以将其添加到您的主题中。这将添加一个 主题许可 页面，用户可以在其中停用或检查许可到期日期。

5. 添加过滤器

在软件包下载中存在一个 merlin-filters-sample.php 文件，其中包含您可能用于修改 Merlin 的不同过滤器的示例。一个主要示例是使用 merlin_generate_child_functions_php 过滤器来修改生成的子主题的 functions.php 文件的内容。

您可能还需要过滤主题演示的首页，以便 Merlin WP 在运行完毕后知道哪些页面应设置为首页。

6. 调试/日志文件

在 .../wp-content/uploads/merlin-wp/main.log 处创建了一个日志文件。在日志文件中，您将看到问题所在。

7. 测试

为了测试，您需要创建一个新的标准 WordPress 安装，并添加使用 Merlin WP 集成的主题构建。然后您可以使用 WP Reset 插件来重置并运行更多测试。

贡献

欢迎任何人贡献 Merlin WP。请阅读贡献此存储库的指南。

您可以通过多种方式贡献

在 GitHub 上提出问题
通过带有您的错误修复和/或新功能的 Pull Request 提交
在增强上提供反馈和建议

许可

开源许可旨在让您使用 Merlin WP 来构建开源和个人项目。Merlin WP 的开源许可为 GPLv3。GPLv3 有许多条款，但最重要的是它如何在您公开分发作品时具有粘性。从 GPL FAQ

如果您以某种方式将修改后的版本公开发布，GPL 要求您将修改后的源代码提供给程序的用户，并符合 GPL。

将使用 Merlin WP 的项目发布为 GPLv3，反过来，要求您的项目也根据 GPLv3 许可。

madebyless / merlin-wp

维护者

详细信息