Misleading comment for wp_get_attachment_link function

[several27]

The comment for function wp_get_attachment_link inside wp-includes/post-template.php says that the first argument can be either int or WP_Post object, but that is not true.
This is the first line inside this function:

$id = intval($id);

This line will cause the error: Object of class WP_Post could not be converted to int.

Please forgive me any mistakes this is my first ticket :)

[SergeyBiryukov]

Hi @several27, welcome to Trac and thanks for the report!

Introduced in [27473]. We could probably just remove the intval() and let get_post() handle the value.

Would you like to try submitting a patch?

[several27]

Replying to SergeyBiryukov:

Hi @several27, welcome to Trac and thanks for the report!

Introduced in [27473]. We could probably just remove the intval() and let get_post() handle the value.

Would you like to try submitting a patch?

Hi and thank you for the incredibly quick answer :)

I just verified it and just removing intval() won't work, line 1546: will have to be changed also:

$link_text = wp_get_attachment_image( $id, $size, $icon, $attr );

to

$link_text = wp_get_attachment_image( $_post->ID, $size, $icon, $attr );

And after that it should work (at least is working for me).

So how should I submit a patch?

[knutsp]

Replying to several27:

So how should I submit a patch?

​https://make.wordpress.org/core/handbook/tutorials/trac/submitting-a-patch/

[several27]

I just uploaded patch, the patch.2.diff should be the correct one.

[MikeHansenMe]

Just dug into this a bit and it looks like it has never supported a post object. The code was introduced in ​https://github.com/WordPress/WordPress/commit/0456afb16d10ad4ccc0d1a5a9b979f35ce7135e0 it looks like the previous function(get_the_attachment_link) that was deprecated also forced int. So is this just a problem with the function doc implying it can be a post object?

[knutsp]

Replying to MikeHansenMe:

So is this just a problem with the function doc stating it can be a post object?

Probably, and that's a bug. This patch solves it, and at the same time, it's an enhancement.

[DrewAPicture]

Replying to knutsp:

Replying to MikeHansenMe:

So is this just a problem with the function doc stating it can be a post object?

Probably, and that's a bug. This patch solves it, and at the same time, it's an enhancement.

So, realistically, we should add a changelog entry mentioning that it now actually supports a WP_Post object.

[DrewAPicture]

+ changelog entry

[DrewAPicture]

33277.diff​ adds the changelog entry and regenerates the patch from root.

[wonderboymusic]

In 33669:

In wp_get_attachment_link(), accept an id or WP_Post as the first parameter.

Props several27, DrewAPicture.
Fixes #33277.