Make WordPress Core

Opened 9 years ago

Closed 9 years ago

#31351 closed defect (bug) (fixed)

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

Reported by: magicroundabout's profile magicroundabout Owned by: drewapicture's profile DrewAPicture
Milestone: 4.2 Priority: normal
Severity: normal Version:
Component: Post Thumbnails Keywords: has-patch commit
Focuses: docs Cc:

Description

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! :)

Attachments (2)

post-thumbnail-comment-patch.diff (1.5 KB) - added by magicroundabout 9 years ago.
Patch to update the comments
31351.diff (2.4 KB) - added by DrewAPicture 9 years ago.

Download all attachments as: .zip

Change History (9)

#1 @DrewAPicture
9 years ago

  • Keywords needs-patch added
  • Type changed from enhancement to defect (bug)
  • Version trunk deleted

#2 @magicroundabout
9 years ago

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

@magicroundabout
9 years ago

Patch to update the comments

#3 follow-up: @magicroundabout
9 years ago

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!

#4 in reply to: ↑ 3 @DrewAPicture
9 years ago

  • Keywords has-patch added; needs-patch removed
  • Milestone changed from Awaiting Review to 4.2
  • Owner set to DrewAPicture
  • Status changed from new to reviewing

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.

#5 @DrewAPicture
9 years ago

  • Keywords commit added

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
9 years ago

This ticket was mentioned in Slack in #core by drew. View the logs.


9 years ago

#7 @DrewAPicture
9 years ago

  • Resolution set to fixed
  • Status changed from reviewing to closed

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.

Note: See TracTickets for help on using tickets.