get_the_post_thumbnail() needs a clearer explanation of the difference between 'post-thumbnail' and 'thumbnail'

[magicroundabout]

Been discussing this with @drewapicture today.

I'd like to add a small comment to the inline docs for get_the_post_thumbnail() to make clear the difference between the image sizes thumbnail and post-thumbnail.

I'm also going to update the codex page on "Post Thumbnails" to clarify the difference there as it's quite confusing. The action to do that is not part of this ticket.

I'm a relative newbie to trac. I may need hand-holding. Be nice! :)

[magicroundabout]

Thanks Drew. I'll get stuck into contributor guides tomorrow and try and create a patch!

[magicroundabout]

Patch to update the comments

[magicroundabout]

Sorry this took a while. I didn't realise creating a patch would be so easy. I've added it.

I hope this whole thing doesn't break rules about trivial patches!

[DrewAPicture]

Replying to magicroundabout:

Sorry this took a while. I didn't realise creating a patch would be so easy. I've added it.

I hope this whole thing doesn't break rules about trivial patches!

No problem! As for "trivial patches", fixing docs doesn't count :)

I'll take a look at your patch and get back to you.

[DrewAPicture]

Hi magicroundabout,

In 31351.diff​, I've reworked the words from your original patch into a more cohesive message that we can use for both get_the_post_thumbnail() and the_post_thumbnail(). Let me know if I missed anything in capturing the spirit of what you were trying to say.

[DrewAPicture]

In 31853:

Adjust DocBlocks for get_|the_post_thumbnail() to clarify the difference between the 'thumbnail' and 'post-thumbnail' image sizes.

Also fleshes out parameter documentation for the two functions.

Props magicroundabout for the initial patch.
Fixes #31351.