WordPress.org

Make WordPress Core

Changeset 46152


Ignore:
Timestamp:
09/16/2019 07:54:15 PM (2 months ago)
Author:
SergeyBiryukov
Message:

Docs: Improve documentation for get_bookmarks().

Props pbiron.
Fixes #48053.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/bookmark.php

    r45667 r46152  
    107107 *     Optional. String or array of arguments to retrieve bookmarks.
    108108 *
    109  *     @type string   $orderby        How to order the links by. Accepts post fields. Default 'name'.
     109 *     @type string   $orderby        How to order the links by. Accepts 'id', 'link_id', 'name', 'link_name',
     110 *                                    'url', 'link_url', 'visible', 'link_visible', 'rating', 'link_rating',
     111 *                                    'owner', 'link_owner', 'updated', 'link_updated', 'notes', 'link_notes',
     112 *                                    'description', 'link_description', 'length' and 'rand'.
     113 *                                    When `$orderby` is 'length', orders by the character length of
     114 *                                    'link_name'. Default 'name'.
    110115 *     @type string   $order          Whether to order bookmarks in ascending or descending order.
    111116 *                                    Accepts 'ASC' (ascending) or 'DESC' (descending). Default 'ASC'.
    112  *     @type int      $limit          Amount of bookmarks to display. Accepts 1+ or -1 for all.
    113  *                                    Default -1.
     117 *     @type int      $limit          Amount of bookmarks to display. Accepts any positive number or
     118 *                                    -1 for all.  Default -1.
    114119 *     @type string   $category       Comma-separated list of category ids to include links from.
    115120 *                                    Default empty.
     
    121126 *     @type string   $include        Comma-separated list of bookmark IDs to include. Default empty.
    122127 *     @type string   $exclude        Comma-separated list of bookmark IDs to exclude. Default empty.
     128 *     @type string   $search         Search terms. Will be SQL-formatted with wildcards before and after
     129 *                                    and searched in 'link_url', 'link_name' and 'link_description'.
     130 *                                    Default empty.
    123131 * }
    124132 * @return array List of bookmark row objects.
Note: See TracChangeset for help on using the changeset viewer.