Make WordPress Core

Opened 5 years ago

Closed 5 years ago

#48053 closed enhancement (fixed)

incomplete DocBlock for get_bookmarks()

Reported by: pbiron's profile pbiron Owned by: sergeybiryukov's profile SergeyBiryukov
Milestone: 5.3 Priority: normal
Severity: normal Version:
Component: General Keywords: has-patch
Focuses: docs Cc:


The DocBlock (and hence, the code reference) for get_bookmarks() is incomplete.

In particular,

  1. the $search param is not mentioned at all
  2. the description of the $orderby param leaves out rand and length as possible values, as well as the "shorthands" for the various fields in the wp_links table
  3. the description of the $limit param may be misleading, implying that '1+' is a legal value

Attachments (1)

48053.diff (2.9 KB) - added by pbiron 5 years ago.

Download all attachments as: .zip

Change History (3)

5 years ago

#1 @SergeyBiryukov
5 years ago

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

#2 @SergeyBiryukov
5 years ago

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

In 46152:

Docs: Improve documentation for get_bookmarks().

Props pbiron.
Fixes #48053.

Note: See TracTickets for help on using tickets.