Changeset 46152

Timestamp:

09/16/2019 07:54:15 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for get_bookmarks().

Props pbiron.
Fixes #48053.

File:

• trunk/src/wp-includes/bookmark.php (modified) (2 diffs)

trunk/src/wp-includes/bookmark.php

@@ -107 +107 @@
  *     Optional. String or array of arguments to retrieve bookmarks.
  *
- *     @type string   $orderby        How to order the links by. Accepts post fields. Default 'name'.
+ *     @type string   $orderby        How to order the links by. Accepts 'id', 'link_id', 'name', 'link_name',
+ *                                    'url', 'link_url', 'visible', 'link_visible', 'rating', 'link_rating',
+ *                                    'owner', 'link_owner', 'updated', 'link_updated', 'notes', 'link_notes',
+ *                                    'description', 'link_description', 'length' and 'rand'.
+ *                                    When `$orderby` is 'length', orders by the character length of
+ *                                    'link_name'. Default 'name'.
  *     @type string   $order          Whether to order bookmarks in ascending or descending order.
  *                                    Accepts 'ASC' (ascending) or 'DESC' (descending). Default 'ASC'.
- *     @type int      $limit          Amount of bookmarks to display. Accepts 1+ or -1 for all.
- *                                    Default -1.
+ *     @type int      $limit          Amount of bookmarks to display. Accepts any positive number or
+ *                                    -1 for all.  Default -1.
  *     @type string   $category       Comma-separated list of category ids to include links from.
  *                                    Default empty.
@@ -121 +126 @@
  *     @type string   $include        Comma-separated list of bookmark IDs to include. Default empty.
  *     @type string   $exclude        Comma-separated list of bookmark IDs to exclude. Default empty.
+ *     @type string   $search         Search terms. Will be SQL-formatted with wildcards before and after
+ *                                    and searched in 'link_url', 'link_name' and 'link_description'.
+ *                                    Default empty.
  * }
  * @return array List of bookmark row objects.