admin管理员组

文章数量:1418056

I'm having trouble navigating the WP documentation so forgive me if this is common knowledge.

Is it possible to view the documentation of classes and methods from within the shell?

That is, is there a command that I can type at the wp-shell prompt that will return the api documentation for a given method/class.

Something like:

doc(get_posts);
#=> get_posts( array $args = null )
# Retrieves an array of the latest posts, or posts matching the given criteria.
# Parameters
# $args
# ...

For example, pry-doc in Ruby provides something similar.

I'm having trouble navigating the WP documentation so forgive me if this is common knowledge.

Is it possible to view the documentation of classes and methods from within the shell?

That is, is there a command that I can type at the wp-shell prompt that will return the api documentation for a given method/class.

Something like:

doc(get_posts);
#=> get_posts( array $args = null )
# Retrieves an array of the latest posts, or posts matching the given criteria.
# Parameters
# $args
# ...

For example, pry-doc in Ruby provides something similar.

  • wp-cli
  • documentation
Share Improve this question edited May 17, 2019 at 9:02 user3574603 asked May 17, 2019 at 8:32 user3574603user3574603 3411 gold badge2 silver badges11 bronze badges 3
  • I'm afraid I don't understand your question. Which documentation? What shell? – cjbj Commented May 17, 2019 at 8:44
  • I've updated my question to be more explicit. – user3574603 Commented May 17, 2019 at 8:53
  • 1 I guess in theory one could create a custom wp-cli command/function with wp_remote_get() on e.g. developer.wordpress, then parse it with e.g. DomDocument and hope the HTML is well structured and similar across the pages :-) It would be an interesting idea to have developer.wordpress available in other formats than HTML. I haven't checked though. – birgire Commented May 17, 2019 at 10:33
Add a comment  | 

2 Answers 2

Reset to default 1

Skimming the available WP-CLI commands I guess there is not something like that. You may create a feature request in the WP-CLI GitHub repo but I doubt that this will gain much attention without you explaining the actual necessity of such command.

Normally when developing, you use your IDE to get hold of those information. A good IDE provides you autocompletion, type hints or shortcuts that let you jump into certain core functions.

Naming PhpStorm as an example which has built-in WordPress support it looks like this when I just start to type wp_:

You could try WP-CLI Reference Command. This is neither an official command, nor can it be used inside wp shell, but will be helpful to you in getting hook / function information from command line.

本文标签： wp cliIs it possible to view WP documentation within the WordPress shell

版权声明：本文标题：wp cli - Is it possible to view WP documentation within the WordPress shell? 内容由网友自发贡献，该文观点仅代表作者本人， 转载请联系作者并注明出处：http://www.betaflare.com/web/1745248855a2649699.html， 本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容，一经查实，本站将立刻删除。