get_bookmarks( string|array $args = '' )

Retrieves the list of bookmarks

Contents

Description Description

Attempts to retrieve from the cache first based on MD5 hash of arguments. If that fails, then the query will be built from the arguments and executed. The results will be stored to the cache.

Parameters Parameters

$args

(string|array) (Optional) String or array of arguments to retrieve bookmarks.

  • 'orderby'
    (string) How to order the links by. Accepts post fields. Default 'name'.
  • 'order'
    (string) Whether to order bookmarks in ascending or descending order. Accepts 'ASC' (ascending) or 'DESC' (descending). Default 'ASC'.
  • 'limit'
    (int) Amount of bookmarks to display. Accepts 1+ or -1 for all. Default -1.
  • 'category'
    (string) Comma-separated list of category ids to include links from.
  • 'category_name'
    (string) Category to retrieve links for by name.
  • 'hide_invisible'
    (int|bool) Whether to show or hide links marked as 'invisible'. Accepts 1|true or 0|false. Default 1|true.
  • 'show_updated'
    (int|bool) Whether to display the time the bookmark was last updated. Accepts 1|true or 0|false. Default 0|false.
  • 'include'
    (string) Comma-separated list of bookmark IDs to include.
  • 'exclude'
    (string) Comma-separated list of bookmark IDs to exclude.

Default value: ''

Top ↑

Return Return

(array) List of bookmark row objects.

Top ↑

Source Source

File: wp-includes/bookmark.php

123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
function get_bookmarks( $args = '' ) {
    global $wpdb;
 
    $defaults = array(
        'orderby'        => 'name',
        'order'          => 'ASC',
        'limit'          => -1,
        'category'       => '',
        'category_name'  => '',
        'hide_invisible' => 1,
        'show_updated'   => 0,
        'include'        => '',
        'exclude'        => '',
        'search'         => '',
    );
 
    $r = wp_parse_args( $args, $defaults );
 
    $key   = md5( serialize( $r ) );
    $cache = false;
    if ( 'rand' !== $r['orderby'] && $cache = wp_cache_get( 'get_bookmarks', 'bookmark' ) ) {
        if ( is_array( $cache ) && isset( $cache[ $key ] ) ) {
            $bookmarks = $cache[ $key ];
            /**
             * Filters the returned list of bookmarks.
             *
             * The first time the hook is evaluated in this file, it returns the cached
             * bookmarks list. The second evaluation returns a cached bookmarks list if the
             * link category is passed but does not exist. The third evaluation returns
             * the full cached results.
             *
             * @since 2.1.0
             *
             * @see get_bookmarks()
             *
             * @param array $bookmarks List of the cached bookmarks.
             * @param array $r         An array of bookmark query arguments.
             */
            return apply_filters( 'get_bookmarks', $bookmarks, $r );
        }
    }
 
    if ( ! is_array( $cache ) ) {
        $cache = array();
    }
 
    $inclusions = '';
    if ( ! empty( $r['include'] ) ) {
        $r['exclude']       = '';  //ignore exclude, category, and category_name params if using include
        $r['category']      = '';
        $r['category_name'] = '';
        $inclinks           = wp_parse_id_list( $r['include'] );
        if ( count( $inclinks ) ) {
            foreach ( $inclinks as $inclink ) {
                if ( empty( $inclusions ) ) {
                    $inclusions = ' AND ( link_id = ' . $inclink . ' ';
                } else {
                    $inclusions .= ' OR link_id = ' . $inclink . ' ';
                }
            }
        }
    }
    if ( ! empty( $inclusions ) ) {
        $inclusions .= ')';
    }
 
    $exclusions = '';
    if ( ! empty( $r['exclude'] ) ) {
        $exlinks = wp_parse_id_list( $r['exclude'] );
        if ( count( $exlinks ) ) {
            foreach ( $exlinks as $exlink ) {
                if ( empty( $exclusions ) ) {
                    $exclusions = ' AND ( link_id <> ' . $exlink . ' ';
                } else {
                    $exclusions .= ' AND link_id <> ' . $exlink . ' ';
                }
            }
        }
    }
    if ( ! empty( $exclusions ) ) {
        $exclusions .= ')';
    }
 
    if ( ! empty( $r['category_name'] ) ) {
        if ( $r['category'] = get_term_by( 'name', $r['category_name'], 'link_category' ) ) {
            $r['category'] = $r['category']->term_id;
        } else {
            $cache[ $key ] = array();
            wp_cache_set( 'get_bookmarks', $cache, 'bookmark' );
            /** This filter is documented in wp-includes/bookmark.php */
            return apply_filters( 'get_bookmarks', array(), $r );
        }
    }
 
    $search = '';
    if ( ! empty( $r['search'] ) ) {
        $like   = '%' . $wpdb->esc_like( $r['search'] ) . '%';
        $search = $wpdb->prepare( ' AND ( (link_url LIKE %s) OR (link_name LIKE %s) OR (link_description LIKE %s) ) ', $like, $like, $like );
    }
 
    $category_query = '';
    $join           = '';
    if ( ! empty( $r['category'] ) ) {
        $incategories = wp_parse_id_list( $r['category'] );
        if ( count( $incategories ) ) {
            foreach ( $incategories as $incat ) {
                if ( empty( $category_query ) ) {
                    $category_query = ' AND ( tt.term_id = ' . $incat . ' ';
                } else {
                    $category_query .= ' OR tt.term_id = ' . $incat . ' ';
                }
            }
        }
    }
    if ( ! empty( $category_query ) ) {
        $category_query .= ") AND taxonomy = 'link_category'";
        $join            = " INNER JOIN $wpdb->term_relationships AS tr ON ($wpdb->links.link_id = tr.object_id) INNER JOIN $wpdb->term_taxonomy as tt ON tt.term_taxonomy_id = tr.term_taxonomy_id";
    }
 
    if ( $r['show_updated'] ) {
        $recently_updated_test = ', IF (DATE_ADD(link_updated, INTERVAL 120 MINUTE) >= NOW(), 1,0) as recently_updated ';
    } else {
        $recently_updated_test = '';
    }
 
    $get_updated = ( $r['show_updated'] ) ? ', UNIX_TIMESTAMP(link_updated) AS link_updated_f ' : '';
 
    $orderby = strtolower( $r['orderby'] );
    $length  = '';
    switch ( $orderby ) {
        case 'length':
            $length = ', CHAR_LENGTH(link_name) AS length';
            break;
        case 'rand':
            $orderby = 'rand()';
            break;
        case 'link_id':
            $orderby = "$wpdb->links.link_id";
            break;
        default:
            $orderparams = array();
            $keys        = array( 'link_id', 'link_name', 'link_url', 'link_visible', 'link_rating', 'link_owner', 'link_updated', 'link_notes', 'link_description' );
            foreach ( explode( ',', $orderby ) as $ordparam ) {
                $ordparam = trim( $ordparam );
 
                if ( in_array( 'link_' . $ordparam, $keys ) ) {
                    $orderparams[] = 'link_' . $ordparam;
                } elseif ( in_array( $ordparam, $keys ) ) {
                    $orderparams[] = $ordparam;
                }
            }
            $orderby = implode( ',', $orderparams );
    }
 
    if ( empty( $orderby ) ) {
        $orderby = 'link_name';
    }
 
    $order = strtoupper( $r['order'] );
    if ( '' !== $order && ! in_array( $order, array( 'ASC', 'DESC' ) ) ) {
        $order = 'ASC';
    }
 
    $visible = '';
    if ( $r['hide_invisible'] ) {
        $visible = "AND link_visible = 'Y'";
    }
 
    $query  = "SELECT * $length $recently_updated_test $get_updated FROM $wpdb->links $join WHERE 1=1 $visible $category_query";
    $query .= " $exclusions $inclusions $search";
    $query .= " ORDER BY $orderby $order";
    if ( $r['limit'] != -1 ) {
        $query .= ' LIMIT ' . $r['limit'];
    }
 
    $results = $wpdb->get_results( $query );
 
    if ( 'rand()' !== $orderby ) {
        $cache[ $key ] = $results;
        wp_cache_set( 'get_bookmarks', $cache, 'bookmark' );
    }
 
    /** This filter is documented in wp-includes/bookmark.php */
    return apply_filters( 'get_bookmarks', $results, $r );
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
2.1.0 Introduced.

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/wp-db.php: wpdb::esc_like()

First half of escaping for LIKE special characters % and _ before preparing for MySQL.
wp-includes/cache.php: wp_cache_get()

Retrieves the cache contents from the cache by key and group.
wp-includes/cache.php: wp_cache_set()

Saves the data to the cache.
wp-includes/functions.php: wp_parse_args()

Merge user defined arguments into defaults array.
wp-includes/functions.php: wp_parse_id_list()

Clean up an array, comma- or space-separated list of IDs.
wp-includes/taxonomy.php: get_term_by()

Get all Term data from database by Term field and data.
wp-includes/plugin.php: apply_filters()

Call the functions added to a filter hook.
wp-includes/bookmark.php: get_bookmarks

Filters the returned list of bookmarks.
wp-includes/wp-db.php: wpdb::get_results()

Retrieve an entire SQL result set from the database (i.e., many rows)
wp-includes/wp-db.php: wpdb::prepare()

Prepares a SQL query for safe execution. Uses sprintf()-like syntax.
Show 5 more uses Hide more uses

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Example

    – Create a link category named “Related Sites”
    – Create a few links, adding them to the “Related Sites” category

    You may use the following code in your templates to retrieve the links:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    $bookmarks = get_bookmarks( array(
        'orderby'        => 'name',
        'order'          => 'ASC',
        'category_name'  => 'Related Sites'
    ) );
     
    // Loop through each bookmark and print formatted output
    foreach ( $bookmarks as $bookmark ) {
        printf( '<a class="relatedlink" href="%1$s">%2$s</a><br />', esc_attr( $bookmark->link_url ), $bookmark->link_name );
    }

You must log in before being able to contribute a note or feedback.