Changes between Version 1 and Version 2 of Ticket #3165
- Timestamp:
- 09/26/2017 03:32:59 PM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
Ticket #3165 – Description
v1 v2 1 1 Recently received a contributor note from @mnelson4 on the reference for `wp_remote_request()` asking about which arguments are accepted, and I realized that we explicitly point to `WP_Http::request()` for additional information on default arguments, except that information isn't exposed anywhere in the wporg-developer theme. 2 2 3 > I can’t find anywhere on developer.wordpress.org that explains what array keys and values `$args` should have in either `wp_remote_request`, `wp_remote_post`, `wp_remote_get` or `wp_remote_head`. 4 > 5 > The codex went over some of the arguments here: https://codex.wordpress.org/HTTP_API (although not all, it missed `body`, for example), and it also has an example that uses a bunch of them here: https://codex.wordpress.org/Function_Reference/wp_remote_post, but that’s just an example not documentation. 6 3 7 I'm thinking maybe we should just expose the contents of the top-level `@see` tags at the end of the description, rather than as part of the explanation (since it's parsed). Either way, this is one very good example of where useful information in the docblock isn't getting translated into the Code Reference for the wider audience. 8 9 From the DocBlock for `wp_remote_request()`: 10 {{{ 11 #!php 12 * 13 * @see WP_Http::request() For additional information on default arguments. 14 * 15 }}}
![(please configure the [header_logo] section in trac.ini)](/chrome/site/your_project_logo.png)