README

WP Code Reference 是一个主题，用于显示WordPress项目（插件或任何遵循内联 WordPress PHP 文档标准的WordPress库或主题）的代码参考。

要求

您需要Composer和WP-CLI，以及PHP 5.4+。

有两种方法可以设置所有内容。

如果您使用Composer（例如，通过 Bedrock 的帮助）管理WordPress安装和插件，您只需要求 dimadin/wp-plugin-code-reference 包，它将安装所有必需的依赖项。

在其他情况下，您需要手动设置所有必需的依赖项。

从主题目录（通常是 /wp-content/themes）中的meta svn仓库检出 developer.wordpress.org 主题。

svn checkout https://meta.svn.wordpress.org/sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/

此存储库包含子主题 WP Code Reference。请在主题目录内克隆此存储库。

在插件目录（通常是 /wp-content/plugins）中，克隆 WP-Parser 并在其中使用 composer install 安装其依赖项。

这不是必需的，但建议安装 SyntaxHighlighter Evolved 插件以获得更好的代码显示。

安装完所有内容后，激活 WP-Parser 和 SyntaxHighlighter Evolved 插件以及 WP Code Reference 主题。

然后，您需要安装或克隆您想要进行代码参考的WordPress项目的仓库。您可以在其标准位置执行此操作（例如，如果它是插件，则在插件目录中）。

最后，您需要从 WP-Parser 运行索引命令。转到项目目录并运行

wp parser create . --user=1

其中 . 代表当前目录，--user=1 是指将帖子归因于的用户ID。

如果您想使“查看GitHub”链接工作，您还必须运行

wp option update wp_parser_gh_repository 'user/repo'

其中 'user/repo' 是指向您的GitHub仓库的路径。如果链接仍然没有显示，请运行

wp option update wp_parser_imported_wp_version 'x.y.z'

其中 'x.y.z' 是基于您的代码参考的标签。

在一个WordPress网站上，您可以为单个项目提供代码参考。如果您想为多个项目提供参考，您需要安装单独的WordPress实例并遵循上述步骤，或者拥有一个WordPress多站点安装，其中网络中的每个站点都针对一个项目。
对于您项目的每个新版本，您都需要运行解析器，如第用法节中所述。然而，请注意，由于 WP-Parser 的限制，不再解析的资源（例如从新版本中删除的资源）不会被从数据库中删除。您需要重置数据库或执行其他操作来删除它们。
目录 /tests 和 /vendor 被跳过，不会在代码引用中显示。