WordPress.org
Get WordPress

Make WordPress Core

Opened 5 years ago

Closed 5 years ago

#50835 closed defect (bug) (fixed)

Return value DocBlock lacked attachment details for wp_prepare_attachment_for_js()

Reported by: stevenlinx's profile stevenlinx Owned by: johnbillion's profile johnbillion
Milestone: 5.6 Priority: normal
Severity: normal Version:
Component: Media Keywords: has-patch commit
Focuses: docs Cc:

Description

Codex:
​https://codex.wordpress.org/Function_Reference/wp_prepare_attachment_for_js

DevHub:
​https://developer.wordpress.org/reference/functions/wp_prepare_attachment_for_js/

Attachments (4)

50835.diff​ (3.2 KB) - added by stevenlinx 5 years ago.
50835.2.diff​ (3.8 KB) - added by Mista-Flo 5 years ago.
Fix doc alignment
50835.3.diff​ (3.6 KB) - added by Mista-Flo 5 years ago.
Fix since prop order
50835.4.diff​ (4.1 KB) - added by johnbillion 5 years ago.

Download all attachments as: .zip

Change History (13)

@stevenlinx
5 years ago

#1 @stevenlinx
5 years ago

  • Keywords has-patch added; needs-patch removed

#2 @SergeyBiryukov
5 years ago

  • Milestone changed from Awaiting Review to 5.6
  • Owner set to SergeyBiryukov
  • Status changed from new to reviewing

This ticket was mentioned in ​Slack in #core-media by antpb. ​View the logs.
5 years ago

#4 @Mista-Flo
5 years ago

  • Keywords needs-refresh added

It probably needs a refresh to fix the alignment, otherwise looks good.

Any thought @SergeyBiryukov?

@Mista-Flo
5 years ago

Fix doc alignment

@Mista-Flo
5 years ago

Fix since prop order

#5 @Mista-Flo
5 years ago

  • Keywords needs-refresh removed

Hi there, I have refreshed the patch to get a proper alignment.

#6 @johnbillion
5 years ago

  • Owner changed from SergeyBiryukov to johnbillion

@johnbillion
5 years ago

#7 @johnbillion
5 years ago

  • Keywords commit added

This is looking good. In 50835.4.diff​ I've made two changes:

  1. Ordered the block by the name of the property.
  2. Remove usage of the Saxon genitive, this is something we don't typically use in core although we're definitely not consistent about it.

Unless anyone objects to the latter, this is ready for commit.

#8 @Mista-Flo
5 years ago

Nice one John thank you, looks good like this.

#9 @SergeyBiryukov
5 years ago

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

In 49281:

Docs: Document the return value of wp_prepare_attachment_for_js() using hash notation.

Props stevenlinx, Mista-Flo, johnbillion.
Fixes #50835.

Note: See TracTickets for help on using tickets.