Make WordPress Core

Opened 4 years ago

Closed 3 years ago

#50853 closed defect (bug) (fixed)

Parameter $linkdata missing array sub-parameters in DocBlock for wp_insert_link()

Reported by: stevenlinx's profile stevenlinx Owned by: sergeybiryukov's profile SergeyBiryukov
Milestone: 5.6 Priority: low
Severity: normal Version:
Component: Administration Keywords: has-patch
Focuses: docs Cc:

Attachments (2)

50853.diff (1.9 KB) - added by stevenlinx 4 years ago.
tck50853.2.diff (2.2 KB) - added by stevenlinx 3 years ago.

Download all attachments as: .zip

Change History (7)

4 years ago

#1 @stevenlinx
4 years ago

  • Keywords has-patch added; needs-patch removed

#2 @SergeyBiryukov
4 years ago

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

#3 @peterwilsoncc
3 years ago

  • Keywords needs-refresh added
  • Priority changed from normal to low


Thanks for the patch, to meet the WordPress documentation standards it will need a few adjustments:

  • Mostly white space in the @type, the variable names should align on $ and the first character of the descriptions should align too. For alignment, use spaces rather than tabs.
  • Each type should be the PHP variable rather than the database type: varchar, datetime and text become string.
  • Optional items will need to be indicated too.

You can read more about the documentation standards in the handbook.

I've labelled this needs-refresh but don't worry if you haven't got time. I've also reduced the priority as the link/blogroll feature has been deprecated for a while so this is less urgent than other issues.

#4 @stevenlinx
3 years ago

  • Keywords needs-refresh removed


Thank you for the feedback.

I've made the adjustments in a new patch.

#5 @SergeyBiryukov
3 years ago

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

In 49487:

Docs: Document the $linkdata parameter of wp_insert_link() using hash notation.

Props stevenlinx, peterwilsoncc.
Fixes #50853.

Note: See TracTickets for help on using tickets.