Skip to content

Docs: correct get_post_custom() return description#10996

Closed
meravi wants to merge 7 commits intoWordPress:trunkfrom
meravi:60646-get-post-custom-docs
Closed

Docs: correct get_post_custom() return description#10996
meravi wants to merge 7 commits intoWordPress:trunkfrom
meravi:60646-get-post-custom-docs

Conversation

@meravi
Copy link

@meravi meravi commented Feb 21, 2026

Trac ticket: https://core.trac.wordpress.org/ticket/60646

Summary

Updates the get_post_custom() docblock in src/wp-includes/post.php to remove the incorrect claim that negative post IDs are invalid. Negative IDs are normalized via absint() in the function, so they should not be documented as invalid.

Changes

  • Docblock only (no functional code changes)

Tested

  • Docs-only change (no runtime behavior affected)

@github-actions
Copy link

github-actions bot commented Feb 21, 2026

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 props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props ravikhadka, westonruter.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@github-actions
Copy link

Test using WordPress Playground

The 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

  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

$post_id = get_the_ID();
}

return get_post_meta( $post_id );
Copy link
Member

Choose a reason for hiding this comment

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

Maybe update the docs for get_post_meta() as well?

Copy link
Author

Choose a reason for hiding this comment

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

Good point, thanks for the suggestion!

Since this ticket specifically addresses the documentation for get_post_custom(), I kept the change scoped to that function.

If it makes sense to align the get_post_meta() docs as well, I’m happy to open a follow-up patch to keep the changes focused and reviewable.

Let me know your preference 🙂

Copy link
Member

Choose a reason for hiding this comment

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

Alright. Fine to keep it scoped to this one function.

Copy link
Author

Choose a reason for hiding this comment

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

Thanks for the confirmation 🙂

@westonruter
Copy link
Member

You do not need to merge the latest changes from trunk, unless there is a merge conflict or likely to be a change in trunk which would impact this branch. If you see "Update Branch" feel free to leave it as-is, as otherwise it just spins up a lot of jobs which aren't going to be doing any meaningful work.

pento pushed a commit that referenced this pull request Feb 23, 2026
…t_custom()`.

Developed in #10996

Follow-up to [52795].

Props ravikhadka, westonruter, swissspidy, roytanck.
See #64224, #55249.
Fixes #60646.


git-svn-id: https://develop.svn.wordpress.org/trunk@61718 602fd350-edb4-49c9-b593-d223f7449a82
@github-actions
Copy link

A commit was made that fixes the Trac ticket referenced in the description of this pull request.

SVN changeset: 61718
GitHub commit: 9e4cb58

This PR will be closed, but please confirm the accuracy of this and reopen if there is more work to be done.

@github-actions github-actions bot closed this Feb 23, 2026
markjaquith pushed a commit to WordPress/WordPress that referenced this pull request Feb 23, 2026
…t_custom()`.

Developed in WordPress/wordpress-develop#10996

Follow-up to [52795].

Props ravikhadka, westonruter, swissspidy, roytanck.
See #64224, #55249.
Fixes #60646.

Built from https://develop.svn.wordpress.org/trunk@61718


git-svn-id: http://core.svn.wordpress.org/trunk@61026 1a063a9b-81f0-0310-95a4-ce76da25c4cd
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants