README

Merlin WP 旨在解决繁琐且耗时的 WordPress 主题设置和入门过程。它使安装新的 WordPress 主题、推荐的 WordPress 插件、自定义设置、小工具和演示内容变得令人兴奋且令人满意。 阅读更多...

测试版 & 测试

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

用法

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

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

现在您只需要在您的 functions.php 文件中引入 class-merlin.php 类、merlin-config.php 和 composer 自动加载文件，如下所示

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

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

您需要以下文件

• content.xml — 使用 WordPress 导出器导出的演示内容
• widgets.wie — 使用 Widget Importer & Exporter 导出的小工具
• customizer.dat — 使用 Customizer Export/Import 导出的自定义设置

一旦你有了这些文件，你可以将它们上传到你的服务器（推荐），或者将它们包含在你的主题中。接下来，在主题中定义一个过滤器，让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_generate_child_functions_php 过滤器来修改生成的子主题的 functions.php 文件的内容。

你可能还需要过滤你的主题演示的主页，这样Merlin WP就知道在它完成后要将哪些页面设置为主页。

6. 调试/日志文件

日志文件位于 .../wp-content/uploads/merlin-wp/main.log。在日志文件中，你会看到出错的地方。

7. 测试

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

贡献

任何人都可以为Merlin WP做出贡献。请阅读贡献此存储库的指南。

你可以通过多种方式做出贡献

1. 在GitHub上提出问题
2. 发送带有你的错误修复和新功能的拉取请求
3. 在 增强功能 上提供反馈和建议

许可

开源许可证旨在让您使用 Merlin WP 来构建开源项目和个人项目。Merlin WP 的开源许可证是 GPLv3。GPLv3 有许多条款，但最重要的是它在你公开分发作品时如何 粘性。请参考 GPL 常见问题解答

如果您以某种方式向公众发布修改后的版本，GPL 要求您在 GPL 的许可下向程序用户提供修改后的源代码。

在 GPLv3 许可下发布使用 Merlin WP 的项目，反过来又要求您的项目也必须以 GPLv3 许可。