Make WordPress Core

Opened 7 years ago

Closed 7 years ago

#48053 closed enhancement (fixed)

incomplete DocBlock for get_bookmarks()

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

Description

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

Download all attachments as: .zip

Change History (3)

@pbiron
7 years ago

#1 @SergeyBiryukov
7 years ago

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

#2 @SergeyBiryukov
7 years ago

  • Resolutionfixed
  • Status reviewingclosed

In 46152:

Docs: Improve documentation for get_bookmarks().

Props pbiron.
Fixes #48053.

Note: See TracTickets for help on using tickets.