nirjharlo/wp-plugin-framework

WordPress 插件快速生产框架。

v1.4.3 2021-02-20 14:19 UTC

README

Build Status Scrutinizer Quality Score

WordPress 插件框架是一个简单轻量级的基座,可以在其上构建任何标准 WP 插件。轻松实现高生产力。它包含各种元素,例如设置页面、数据表、小工具、元盒、自定义文章类型、短代码以及数据库操作的基础设施。

还包含用于 API 集成、AJAX、文件上传和计划任务的额外类。

注意:需要 PHP 5.4 及以上版本。使用 cURL 进行 API 集成类。

安装

  1. 生产环境
composer install --no-dev
  1. 开发环境
composer install
./vendor/bin/phpcs --config-set installed_paths ../../wp-coding-standards/wpcs

用法

  1. 在开始编码之前,请在 wp-plugin-framework.phpinstall.php 中更改类命名空间、文件命名空间和声明。还将插件文件 wp-plugin-framework.php 中的 /asset 文件路径更改为您选择的文件夹路径名称。这是一种预防措施,以避免冲突。

  2. plugin/PluginLoader.php 中,PluginLoader 类包含实例中的所有文件并声明其中的类。您可以删除现有文件或添加更多文件。建议将所有插件功能实例放在 PluginLoader 中。这将有助于代码的组织。

  3. plugin/PluginLoader.php 中,安装和卸载类包含可能的情况,包括数据库安装和卸载功能。

功能

查看 /lib/class-/src/class- 中的文件。前者包含额外功能的类,而后者使用基本功能。

/plugin/lib 文件

/plugin/lib/Cron.php :: Cron 用于安排操作。

/plugin/lib/Api.php :: Api 用于集成第三方 API。

/plugin/lib/Table.php :: Table 用于显示数据表。

/plugin/lib/Ajax.php :: Ajax 用于执行 AJAX 请求。

/plugin/lib/Upload.php :: Upload 用于上传文件。

/plugin/lib/Script.php :: Script 用于添加所需的 CSS 和 JS。

/plugin/src 文件

/plugin/src/Install.php :: Install 用于处理激活过程。

/plugin/src/Db.php :: Db 用于安装数据库表。

/plugin/src/Settings.php :: Settings 用于创建管理员设置页面。

/plugin/src/Cpt.php :: Cpt 用于创建自定义文章类型。

/plugin/src/Widget.php :: Widget 用于添加自定义小工具。

/plugin/src/Metabox.php :: Metabox 用于在编辑器屏幕中添加自定义元盒。

/plugin/src/Shortcode.php :: Shortcode 用于添加和显示短代码。

/plugin/src/Query.php :: Query 用于使用帖子查询和用户查询。它使用 wp_pagenavi() 进行导航。

/plugin/src/RestApi.php :: RestApi 用于扩展 REST API。