mehrshaddarzi/wp-cli-reference-command

WordPress 代码参考包,适用于 WP-CLI。

v1.0.3 2020-02-20 14:04 UTC

This package is auto-updated.

Last update: 2024-09-20 10:02:14 UTC


README

Build Status Packagist Version GitHub

WP-CLI 的 WordPress 代码参考。

快速链接:安装 | 使用 | 贡献

安装

您可以使用以下方式安装此包

wp package install mehrshaddarzi/wp-cli-reference-command

安装此包需要 WP-CLI v2 或更高版本。使用 wp cli update 更新到最新稳定版本。

使用

NAME

  wp reference

DESCRIPTION

  WordPress Code Reference.

SYNOPSIS

  wp reference <class|method|function|hook>

搜索并显示文档结果

wp reference absint

结果

如果您的搜索结果来自多个项目,例如

wp reference wp_insert_post

您将看到一个选择列表。

自定义搜索

默认情况下,WP_CLI 参考包在所有 WordPress 类和函数之间进行搜索。

如果您想进行自定义搜索

wp reference --class=wp_user
wp reference --funcion=wp_insert_post
wp reference --method=get_row
wp reference --hook=admin_footer

在 Web 浏览器中显示

您可以使用以下方式在搜索后显示 WordPress 代码参考

wp reference --browser

缓存系统

默认情况下,WP-CLI 缓存了 1000 条最近搜索以提高速度。如果想要删除参考缓存

wp cli cache clear

如果您只想删除参考缓存

wp reference --clear

作者

贡献

我们感谢您主动为这个项目做出贡献。

贡献不仅限于代码。我们鼓励您以最适合您能力的方式做出贡献,例如编写教程、在当地聚会中展示、帮助其他用户回答支持问题或修订我们的文档。

报告错误

认为你发现了一个错误?我们很乐意让你帮助我们修复它。在创建新问题之前,你应该搜索现有问题,看看是否有现有的解决方案,或者它是否已在更新的版本中修复。

创建 pull request

想要贡献一个新功能?请首先创建一个新的问题来讨论这个功能是否适合这个项目。

一旦你决定投入时间来完成你的 pull request,请遵循我们的 pull request 创建指南以确保它是一个愉快的体验

  1. 为每次贡献创建一个功能分支。
  2. 尽早提交你的 pull request 以获取反馈。
  3. 遵循 PSR-2 编码标准