Docs: Fix @param type for get_posts()#11179
Docs: Fix @param type for get_posts()#11179rodrigoprimo wants to merge 1 commit intoWordPress:trunkfrom
@param type for get_posts()#11179Conversation
The `$args` parameter is passed through `wp_parse_args()`, which accepts both arrays and query strings. Update the `@param` type from `array` to `array|string` to reflect this, consistent with other functions like `wp_list_categories()` and `get_terms()`.
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Test using WordPress PlaygroundThe changes in this pull request can previewed and tested using a WordPress Playground instance. WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser. Some things to be aware of
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
| * | ||
| * @param array $args { | ||
| * @param array|string $args { | ||
| * Optional. Arguments to retrieve posts. See WP_Query::parse_query() for all available arguments. |
There was a problem hiding this comment.
| * Optional. Arguments to retrieve posts. See WP_Query::parse_query() for all available arguments. | |
| * Optional. Arguments to retrieve posts. See WP_Query::parse_query() for all available arguments. | |
| * A query string may also be provided. |
There was a problem hiding this comment.
Thanks for the review, @westonruter!
Other functions that already document string|array mention it inline in the description instead of using a separate line. For example, wp_dropdown_categories() uses "Optional. Array or string of arguments to generate a categories drop-down element." and wp_list_pages() uses "Optional. Array or string of arguments to generate a list of pages."
What do you think about using something like "Optional. Array or query string of arguments to retrieve posts." here instead, to stay consistent with the existing pattern?
| * Optional. Arguments to retrieve posts. See WP_Query::parse_query() for all available arguments. | |
| * Optional. Array or query string of arguments to retrieve posts. | |
| * See WP_Query::parse_query() for all available arguments. |
3 participants
The
$argsparameter is passed throughwp_parse_args(), which accepts both arrays and query strings. This updates the@paramtype fromarraytoarray|stringto reflect this, consistent with other functions likewp_list_categories()andget_terms().Trac ticket: https://core.trac.wordpress.org/ticket/64813
This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.