Make WordPress Core

Opened 6 years ago

Closed 6 years ago

#50853 closed defect (bug) (fixed)

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

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

Description

Attachments (2)

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

Download all attachments as: .zip

Change History (7)

@stevenlinx
6 years ago

#1 @stevenlinx
6 years ago

  • Keywords has-patch added; needs-patch removed

#2 @SergeyBiryukov
6 years ago

  • Milestone Awaiting Review5.6
  • Owner set to SergeyBiryukov
  • Status newreviewing

#3 @peterwilsoncc
6 years ago

  • Keywords needs-refresh added
  • Priority normallow

@stevenlinx

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

  • Keywords needs-refresh removed

@peterwilsoncc

Thank you for the feedback.

I've made the adjustments in a new patch.

#5 @SergeyBiryukov
6 years ago

  • Resolutionfixed
  • Status reviewingclosed

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.