🚀 WordPress 插件开发指南

本指南将详细介绍 WordPress 插件的安装、配置、功能使用、自定义请求等内容，助您轻松上手 WordPress 插件开发。

🚀 快速开始

安装步骤

1. 登录您的 WordPress 管理界面。
2. 导航至 插件 > 添加插件。
3. 在搜索栏中输入插件名称，点击“安装现在”按钮。
4. 安装完成后，点击“激活”以启用插件。

配置指南

• 打开 WordPress 管理界面中的插件设置页面。
• 填写必要的配置选项（如 API 键、秘密密钥等）。
• 保存设置即可完成配置。

✨ 主要特性

文章管理

获取文章列表

• 功能描述：返回指定条件下的文章列表。
• 参数说明：
  • perPage：每页显示的文章数量（默认为10）。
  • page：当前请求的页码（默认为1）。
  • searchTerm：搜索关键词。

创建新文章

• 功能描述：新增一篇 WordPress 文章。
• 必要参数：
  • title：文章标题。
  • content：文章内容。
  • customFields：自定义字段数据。

媒体管理

获取媒体文件列表

• 功能描述：返回指定条件下的媒体文件列表。
• 可选参数：
  • mediaType：媒体类型（如图片、视频等）。
  • searchTerm：搜索关键词。

新增媒体文件

• 功能描述：上传并存储新的媒体文件到 WordPress。
• 必要参数：
  • file：待上传的文件路径或二进制数据。
  • fileName：文件名称（可自定义）。
  • description：文件描述信息。

分类管理

获取分类列表

• 功能描述：返回所有 WordPress 分类信息。
• 参数说明：
  • perPage：每页显示的分类数量（默认为10）。
  • page：当前请求的页码（默认为1）。

创建新分类

• 功能描述：新增一个新的 WordPress 分类。
• 必要参数：
  • categoryName：分类名称。
  • customData：可选附加数据（如分类描述、父分类ID等）。

自定义请求

发送自定义请求

• 功能描述：支持发送任意的 WordPress REST API 请求。
• 必要参数：
  • siteUrl：站点 URL 地址。
  • username：WordPress 用户名。
  • password：用户密码。
• 可选参数：
  • customEndpoint：自定义请求路径（如 /wp/v2/posts）。
  • customMethod：请求方法（默认为 GET，支持 POST、PUT、DELETE）。
  • customData：POST 或 PUT 请求的主体数据。
  • customParams：URL 查询参数。

示例

{
  "tool": "custom_request",
  "siteUrl": "https://example.com",
  "username": "admin",
  "password": "your_password_here",
  "customEndpoint": "/wp/v2/posts/123",
  "customMethod": "DELETE"
}

📚 详细文档

响应格式

数据结构

• 成功响应：

{
  "status": "success",
  "data": {...},
  "message": "操作成功"
}

• 失败响应：

{
  "status": "error",
  "code": "404",
  "message": "资源未找到"
}

分页与排序

• 支持自定义分页和排序功能。
• 可通过 orderBy 和 orderDirection 参数控制返回结果的顺序。

安全考虑

基本安全措施

1. 确保 WordPress 核心程序和插件始终处于最新版本状态。
2. 避免使用过于简单的密码，建议采用强密码策略。
3. 定期备份网站数据，以防万一。

应用密码管理

• 使用 WordPress 的应用密码功能来增强安全性。
• 应用密码允许您为特定应用程序创建受限的访问权限，而无需共享主用户密码。

开发与贡献

提交代码规范

1. 遵循 Git 版本控制流程，确保代码提交清晰可追溯。
2. 在 Pull Request 中详细说明修改内容和目的。
3. 确保单元测试覆盖率达标，并通过所有自动化检测。

贡献指南

• 欢迎社区开发者参与项目贡献。
• 请在提出更改前先阅读项目文档和代码规范。

📄 许可证

• MIT License：允许自由使用、修改和分发，但需保留版权声明。
• GPL v3.0：遵循开源协议进行二次开发和发布。

通过以上指南，您可以轻松上手 WordPress 插件的安装、配置与开发。如需进一步支持，请参考官方文档或联系社区开发者。