Skip to content

Docs: Fix @param type for get_posts() #11179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rodrigoprimo wants to merge 1 commit into
base: trunk
Choose a base branch
from
Open

Docs: Fix @param type for get_posts() #11179

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/wp-includes/post.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2599,7 +2599,7 @@ function is_post_embeddable( $post = null ) {
* @see WP_Query
* @see WP_Query::parse_query()
*
* @param array $args {
* @param array|string $args {
Copy link
Member

@westonruter westonruter Mar 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically, wp_parse_args() can take an object too: string|array|object. However, I'm not sure we want to necessarily encourage that. Just because you can pass something doesn't mean you should. The same could be said for string.

* Optional. Arguments to retrieve posts. See WP_Query::parse_query() for all available arguments.
Copy link
Member

@westonruter westonruter Mar 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* 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.

*
* @type int $numberposts Total number of posts to retrieve. Is an alias of `$posts_per_page`
Expand Down
Loading