ion/wp-devhelper

一个抽象和简化WordPress开发的库 - 也可以作为已安装的WordPress插件使用,提供额外的开发工具。

v0.90.1 2024-04-17 20:34 UTC

README

WP Devhelper Logo

License: LGPL v3

WP Devhelper

WP Devhelper 是一个函数库,主题和插件开发者可以使用它来通过尽可能抽象标准的WordPress功能、钩子和设置,为用户提供一致的使用体验 - 从而使得使用WordPress进行开发变得更为简单和高效(当前WordPress目标版本为 4.9.2)。

WP Devhelper 帮助开发者不再需要担心WordPress特定的实现细节和潜在问题 - 让他们可以专注于构建出色的东西!

WP Devhelper 可以作为

  • 一个包含的PHP库(作为主题或插件的组成部分),
  • 或者作为一个已安装的插件(可以通过WordPress的更新机制方便地更新)。

功能

  • 前端WordPress API方法和钩子包装器
  • 后端WordPress API方法和钩子包装器(包括快速UI开发)
  • 支持MVC或MVVMC方法
  • 数据库和文件日志;如果启用了后端工具UI,还包括日志查看器
  • WordPress选项编辑器(如果启用了后端工具UI)
  • WP_DEBUG指示器(在后端)

入门指南

### 作为包含的库,使用Composer

确保已安装Composer - 如果没有,您可以从此处获取。

首先,您需要将 WP Devhelper 添加到您的 composer.json 文件中的依赖项。

要使用当前稳定版本,请将以下内容添加到直接从 此处下载

请注意! 目前没有稳定版本可用,WP Devhelper 仍在开发中,直到版本 1.0.0 - 这里的内容仅供参考(目前使用 "ion/wp-devhelper": "dev-default")

"require": {
    "php": ">=7.0",
    "ion/wp-devhelper": "^1.*",
}

要使用最新(开发)版本,请添加以下内容

"require": {
    "php": ">=7.1",
    "ion/wp-devhelper": "dev-default",	
},
"repositories": {
    {
      "type": "vcs",
      "url": "https://bitbucket.org/wpsolved/wp-devhelper/"
    }
}

然后,在您的项目的根目录中运行以下命令

php composer.phar install

### 作为WordPress插件(使用 wordpress.org

请注意! 目前没有稳定版本可用,WP Devhelper 仍在开发中,直到版本 1.0.0 - 这里的内容仅供参考。

只需登录到您的WordPress安装,导航到

插件 > 添加新插件

然后搜索 'WP Devhelper' 并像安装任何其他插件一样安装。

### 作为WordPress插件(使用手动上传)

下载打包版本(.ZIP 格式),此处

登录到您的WordPress安装并导航到

插件 > 添加新插件 > 上传插件

然后选择 .ZIP 文件并上传。

### 作为包含的库,不使用Composer

下载打包版本(.ZIP 格式),此处

解压缩包并确保包含 'include.php',如下所示(假设您已将包解压到相对路径 'includes/wp-devhelper')

require_once( __DIR__ . '/includes/wp-devhelper/include.php' ); 

先决条件

  • WordPress
  • Composer(可选

构建工具

  • Composer - 依赖管理
  • Phing - 用于为各种目标PHP版本(5.6、7.0、7.1)生成自定义构建
  • NetBeans - 集成开发环境(IDE)
  • PHP Storm - 集成开发环境(IDE)

版本控制

我们使用语义版本控制(SemVer)进行版本控制。有关可用的版本,请参阅此存储库的标签

作者

许可证

此项目受LGPL-3.0许可证的许可 - 有关详细信息,请参阅LICENSE.md文件。