Skip to content

9.2 准备主题提交

当你完成WordPress主题的开发后,如果你想将主题提交到WordPress.org主题目录,你需要做好充分的准备工作。本章节将详细介绍如何准备主题提交,包括主题文件结构、主题信息、文档等。

主题文件结构

一个标准的WordPress主题应该包含以下文件和目录:

1. 核心文件

  • style.css:主题的主样式文件,包含主题的信息头
  • index.php:主题的默认模板文件
  • header.php:网站头部模板文件
  • footer.php:网站底部模板文件
  • functions.php:主题的功能文件

2. 可选文件

  • single.php:单篇文章模板文件
  • page.php:页面模板文件
  • archive.php:归档页面模板文件
  • category.php:分类页面模板文件
  • tag.php:标签页面模板文件
  • 404.php:404错误页面模板文件
  • search.php:搜索结果页面模板文件
  • comments.php:评论模板文件

3. 目录结构

  • assets/:存放静态资源,如CSS、JavaScript、图像等
    • css/:存放CSS文件
    • js/:存放JavaScript文件
    • images/:存放图像文件
  • inc/:存放主题的包含文件
    • customizer.php:主题定制器设置
    • template-tags.php:自定义模板标签
    • extras.php:额外功能
  • templates/:存放自定义模板文件
  • languages/:存放语言文件

主题信息头

主题的style.css文件必须包含完整的主题信息头,这是WordPress识别主题的重要依据。

基本信息

css
/*
Theme Name: My Custom Theme
Theme URI: https://example.com/my-custom-theme
Author: Your Name
Author URI: https://example.com
Description: A custom WordPress theme
Version: 1.0.0
License: GNU General Public License v2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Text Domain: my-custom-theme
Tags: custom-background, custom-logo, custom-menu, featured-images, threaded-comments, translation-ready

This theme, like WordPress, is licensed under the GPL.
Use it to make something cool, have fun, and share what you've learned with others.
*/

信息头字段说明

  • Theme Name:主题的名称,必须唯一
  • Theme URI:主题的官方网站地址
  • Author:主题的作者名称
  • Author URI:作者的网站地址
  • Description:主题的描述,简短说明主题的功能和特点
  • Version:主题的版本号,遵循语义化版本规范
  • License:主题的许可证,通常为GNU General Public License v2 or later
  • License URI:许可证的官方地址
  • Text Domain:主题的文本域,用于国际化
  • Tags:主题的标签,用于在WordPress.org主题目录中分类和搜索

主题文档

为主题提供完整的文档,有助于用户了解主题的功能和使用方法。

1. README文件

创建一个README.md文件,包含以下内容:

  • 主题介绍:简要介绍主题的功能和特点
  • 安装说明:详细说明如何安装和激活主题
  • 使用方法:详细说明如何使用主题的各种功能
  • 自定义选项:说明主题的自定义选项和设置
  • 支持信息:提供支持信息,如支持论坛或联系邮箱
  • 更新日志:记录主题的更新历史

2. 主题选项文档

如果主题包含自定义选项或设置,创建一个文档说明如何使用这些选项。

3. 开发者文档

为主题的开发者提供文档,说明主题的代码结构、API和扩展方法。

主题测试

在提交主题之前,需要对主题进行全面的测试,确保主题的质量和功能。

1. 功能测试

  • 基本功能:测试主题的基本功能,如导航菜单、小工具区域、评论系统等
  • 响应式设计:测试主题在不同屏幕尺寸下的显示效果
  • 自定义选项:测试主题的自定义选项和设置
  • 插件兼容性:测试主题与常用WordPress插件的兼容性

2. 性能测试

  • 加载速度:测试主题的加载速度,确保加载迅速
  • 资源优化:检查主题的CSS和JavaScript文件是否经过压缩和优化
  • 数据库查询:检查主题是否有不必要的数据库查询

3. 安全性测试

  • 代码安全:检查主题代码是否存在安全漏洞
  • 用户输入:检查主题是否对用户输入进行适当的转义
  • 文件权限:检查主题文件的权限设置是否正确

4. 可访问性测试

  • WCAG标准:测试主题是否符合WCAG 2.1标准
  • 键盘导航:测试主题是否可以通过键盘导航
  • 屏幕阅读器:测试主题是否对屏幕阅读器友好
  • 颜色对比度:测试主题的颜色对比度是否符合标准

主题打包

在提交主题之前,需要将主题打包成一个ZIP文件。

1. 准备打包文件

  • 移除不必要的文件:移除开发过程中产生的临时文件和测试文件
  • 压缩资源文件:压缩CSS和JavaScript文件,减少文件大小
  • 检查文件权限:确保主题文件的权限设置正确

2. 打包主题

  • 创建ZIP文件:将主题文件夹打包成一个ZIP文件
  • 命名规范:使用主题名称作为ZIP文件的名称,如my-custom-theme.zip
  • 文件大小:确保ZIP文件的大小不超过WordPress.org的限制(通常为5MB)

主题提交

准备好主题后,可以在WordPress.org主题目录提交主题。

1. 注册WordPress.org账号

如果还没有WordPress.org账号,需要先注册一个。

2. 提交主题

  • 登录WordPress.org:登录WordPress.org账号
  • 进入主题提交页面:进入WordPress.org主题目录的提交页面
  • 上传主题:上传主题的ZIP文件
  • 填写主题信息:填写主题的名称、描述、标签等信息
  • 提交审核:提交主题进行审核

3. 审核过程

  • 初步审核:WordPress.org的审核团队对主题进行初步审核
  • 代码审核:审核团队对主题的代码进行详细审核
  • 功能测试:审核团队对主题的功能进行测试
  • 批准或拒绝:审核团队根据审核结果决定是否批准主题

主题提交的最佳实践

  1. 遵循WordPress编码标准:确保主题代码符合WordPress的编码标准
  2. 使用WordPress API:使用WordPress提供的API,而不是直接操作数据库或文件系统
  3. 确保安全性:对用户输入进行适当的转义,使用nonce防止CSRF攻击
  4. 优化性能:优化主题代码和资源文件,提高网站的加载速度
  5. 测试兼容性:测试主题与常用WordPress插件的兼容性
  6. 提供文档:提供完整的主题文档,说明主题的功能和使用方法
  7. 遵循可访问性标准:确保主题符合可访问性标准,使所有用户都能访问和使用
  8. 检查文件结构:确保主题的文件结构符合WordPress的标准
  9. 填写完整的主题信息:确保主题的style.css文件包含完整的主题信息头
  10. 准备打包文件:确保主题的ZIP文件大小不超过限制,包含所有必要的文件

小结

准备主题提交是将主题发布到WordPress.org主题目录的重要步骤。通过本章节的学习,你应该:

  1. 了解主题的文件结构和组织方式
  2. 掌握主题信息头的编写方法
  3. 了解如何创建主题文档
  4. 掌握主题测试的方法
  5. 了解如何打包和提交主题
  6. 掌握主题提交的最佳实践

在后续的章节中,我们将详细介绍如何进行主题的维护和更新,以及如何处理用户反馈。

© 2026 编程马·菜鸟教程 版权所有