Update docblocks & parameters in wp-includes/link-template.php for post-related functions

[GunGeekATX]

The following functions have docblocks and parameters that appear to only accept the post ID, but the underlying code calls get_post() so either post ID or a post object can be accepted.

• get_post_permalink()
• get_edit_post_link()
• edit_post_link()
• get_delete_post_link()

[adamsilverstein]

Overall this makes sense, however, I don't think get_post_permalink actually accepts a post object currently.

In your change at line 267, you call get_post_status with a WP_Post object, but that function takes a post ID - maybe change to $post->ID? Also I want to make sure the $id isn't used elsewhere.

[adamsilverstein]

In your change at line 267, you call get_post_status with a WP_Post object, but that function takes a post ID - maybe change to $post->ID? Also I want to make sure the $id isn't used elsewhere.

Actually thats wrong :) I was looking at outdated docs! It should work as is.

[adamsilverstein]

Maybe the changes should just be for the documentation and don't change the variable names?

[DrewAPicture]

I've iterated the patch with 40780.diff​ in what I think is a fair compromise.

I think we're fine keeping the $id parameter since it's so consistent between the functions already, but there's definitely value in better documenting the types accepted.

Also, I've gone ahead and kept the suggested use of $post for checking the post status in get_post_permalink() as referencing back to the original $id parameter several lines after retrieving the full object seemed weird. get_post_status() can accept an ID or WP_Post object too, so that's fine.

Maybe at some later point we should go through and rename all of these variables at once, but for the purposes of this ticket, let's keep it simple :-)

[DrewAPicture]

In 40975:

Link Template: Clarify documentation for the $id parameter in get_post_permalink(), get_edit_post_link(), edit_post_link(), and get_delete_post_link(), to reflect that either a post ID or WP_Post object is accepted.

Separately, use $post for checking the post status and retrieving the page_uri in get_post_permalink() instead of referencing back to the original $id parameter.

Props GunGeekATX for the initial patch.
Fixes #40780.