README

可扩展的 PHP 类，方便定制。

开箱即用

• 仪表板：设置和工具页面（无限量）
• 自定义数据库缓存
• 支持 Ajax 请求
• 自定义管理员通知和瞬态数据
• CSS/JS 资产：从部分合并，构建，压缩 & 排队

介绍

此包旨在提供一个基础，用于创建具有基本功能的自定义 WordPress 插件，例如设置页面或数据库缓存支持。

此包将在 Composer [vendor] 目录中安装，使其无法从 WordPress 安装中访问。您必须在 WP [plugins] 目录中创建自己的文件夹，并仅扩展项目所需的类。此类插件的示例可以在此找到： Base1

创建插件

创建您的插件入口点文件 [WP]/wp-content/plugins/[your_plugin]/plugin.php，然后仅 run() 必要的部分

namespace My\Name;
/*
 * Plugin Name: My plugin
 */
$Factory = new Factory();
$Factory->Plugin()->run();
$Factory->Settings()->run();

工具

Base1 包包含一些示例工具及其 CSS/JS 资产（/assets 目录）和 FORM 输入定义（/config 目录）。包含的工具包括

$Factory->Mailer()->run(); // Example with WP Mail form
$Factory->Formix()->run(); // Example how to create custom FORM with various inputs
$Factory->Ajaxer()->run(); // Example how to handle Ajax requests

这些工具的链接将自动显示在：仪表板 > 插件 > 我的插件 - 元数据行。

CSS/JS 资产

示例 CSS/JS 资产是预先构建和压缩的，但您可以通过在 wp-config.php 文件中添加以下常量来修改它们并在页面刷新时重新构建

define( 'ORK_ASSET_REBUILD_CSS', true );
define( 'ORK_ASSET_REBUILD_JS', true );
define( 'ORK_ASSET_MINIFY_CSS', true );
define( 'ORK_ASSET_MINIFY_JS', true );

另一种重新构建资产的方法是使用 Composer 脚本命令：在下一节中描述的 composer run rebuildOrkWpBaseAssets

Composer

Composer 是安装此插件及其所有依赖项以及支持类文件自动加载所必需的。此 README 假设您的 Composer/WordPress 安装具有以下目录结构

/htdocs
  |- /html <-- WordPress files
  |- /vendor <-- Composer files
  |- composer.json <-- root file

将 composer 自动加载器添加到 wp-config.php 文件

require __DIR__ . '/../vendor/autoload.php';

通过在您的插件的 composer.json 文件中添加以下行将您的插件转换为 Composer 包

"name": "my/wp-plugin",
"type": "wordpress-plugin",
"require": {
	"orkan/wp-base": "^3"
},
"autoload": {
	"psr-4": {
		"My\\Name\\": "src"
	}
},
"extra": {
	"installer-name": "my-plugin"
}

要正确安装从 Composer 存储库安装的 WP 插件，请将以下行添加到您的根 composer.json 文件中

"extra": {
	"installer-paths": {
		"html/wp-content/plugins/{$name}": [
			"type:wordpress-plugin"
		],
		"html/wp-content/themes/{$name}": [
			"type:wordpress-theme"
		]
	}
}

如果您决定使用 Composer 脚本功能自动构建资产，例如在每次 "dump autoload" 时，您可以使用包含的方法 Orkan\\WP\\Base\\Utils\\Composer::rebuildAssets

"extra": {
	"ork-wp-base": {
		"wp-config": "html/wp-config.php"
	}
}
"scripts": {
	"rebuildMyPluginAssets": [
		"@putenv FACTORY=Orkan\\WP\\MyPlugin\\Factory",
		"Orkan\\WP\\Base\\Utils\\Composer::rebuildAssets"
	],
	"post-autoload-dump": [
		"@rebuildMyPluginAssets"
	]
}

现在您也可以通过运行此命令手动重新构建资产： composer run rebuildMyPluginAssets

要求

• PHP ^7
• Composer ^2
• WordPress ^6

许可

MIT

作者

Orkan

更新

周日，2024年5月26日 17:31:07 +02:00