WordPress.org
Get WordPress

Make WordPress Core

Ticket #48053: 48053.diff

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

  • src/wp-includes/bookmark.php 

    From f58ca33ba8f413a90de2b05ac061144e8dcf3d38 Mon Sep 17 00:00:00 2001
From: Paul Biron <paul@sparrowhawkcomputing.com>
Date: Mon, 16 Sep 2019 13:06:55 -0600
Subject: [PATCH] Flesh out the DocBlock for get_bookmarks().

---
 src/wp-includes/bookmark.php | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)

diff --git a/src/wp-includes/bookmark.php b/src/wp-includes/bookmark.php
index fd2c926591..d430b216da 100644
    a b function get_bookmark_field( $field, $bookmark, $context = 'display' ) { 
    106106 * @param string|array $args {
    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',
     110 *                                    'name', 'link_name', 'url', 'link_url', 'visible', 'link_visible',
     111 *                                    'rating', 'link_rating', 'owner', 'link_owner', 'updated',
     112 *                                    'link_updated', 'notes', 'link_notes', 'description',
     113 *                                    'link_description', 'length' and 'rand'. Default 'name'.
     114 *                                    When `$orderby` is 'lenth', orders by the character length of
     115 *                                    'link_name'.
    110116 *     @type string   $order          Whether to order bookmarks in ascending or descending order.
    111117 *                                    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.
     118 *     @type int      $limit          Amount of bookmarks to display. Accepts any positive number or
     119 *                                    -1 for all.  Default -1.
    114120 *     @type string   $category       Comma-separated list of category ids to include links from.
    115121 *                                    Default empty.
    116122 *     @type string   $category_name  Category to retrieve links for by name. Default empty.
    … … function get_bookmark_field( $field, $bookmark, $context = 'display' ) { 
    120126 *                                    Accepts 1|true or 0|false. Default 0|false.
    121127 *     @type string   $include        Comma-separated list of bookmark IDs to include. Default empty.
    122128 *     @type string   $exclude        Comma-separated list of bookmark IDs to exclude. Default empty.
     129 *     @type string   $search         Search terms. Will be SQL-formatted with wildcards before and after
     130 *                                    and searched in 'link_url', 'link_name' and 'link_description'.
     131 *                                    Default empty.
    123132 * }
    124133 * @return array List of bookmark row objects.
    125134 */