10 * Retrieve Bookmark data based on ID
13 * @uses $wpdb Database Object
15 * @param int $bookmark_id
16 * @param string $output Optional. Either OBJECT, ARRAY_N, or ARRAY_A constant
17 * @param string $filter Optional, default is 'raw'.
18 * @return array|object Type returned depends on $output value.
20 function get_bookmark($bookmark, $output = OBJECT, $filter = 'raw') {
23 if ( empty($bookmark) ) {
24 if ( isset($GLOBALS['link']) )
25 $_bookmark = & $GLOBALS['link'];
28 } elseif ( is_object($bookmark) ) {
29 wp_cache_add($bookmark->link_id, $bookmark, 'bookmark');
30 $_bookmark = $bookmark;
32 if ( isset($GLOBALS['link']) && ($GLOBALS['link']->link_id == $bookmark) ) {
33 $_bookmark = & $GLOBALS['link'];
34 } elseif ( ! $_bookmark = wp_cache_get($bookmark, 'bookmark') ) {
35 $_bookmark = $wpdb->get_row($wpdb->prepare("SELECT * FROM $wpdb->links WHERE link_id = %d LIMIT 1", $bookmark));
36 $_bookmark->link_category = array_unique( wp_get_object_terms($_bookmark->link_id, 'link_category', array('fields' => 'ids')) );
37 wp_cache_add($_bookmark->link_id, $_bookmark, 'bookmark');
41 $_bookmark = sanitize_bookmark($_bookmark, $filter);
43 if ( $output == OBJECT ) {
45 } elseif ( $output == ARRAY_A ) {
46 return get_object_vars($_bookmark);
47 } elseif ( $output == ARRAY_N ) {
48 return array_values(get_object_vars($_bookmark));
55 * Retrieve single bookmark data item or field.
58 * @uses get_bookmark() Gets bookmark object using $bookmark as ID
59 * @uses sanitize_bookmark_field() Sanitizes Bookmark field based on $context.
61 * @param string $field The name of the data field to return
62 * @param int $bookmark The bookmark ID to get field
63 * @param string $context Optional. The context of how the field will be used.
66 function get_bookmark_field( $field, $bookmark, $context = 'display' ) {
67 $bookmark = (int) $bookmark;
68 $bookmark = get_bookmark( $bookmark );
70 if ( is_wp_error($bookmark) )
73 if ( !is_object($bookmark) )
76 if ( !isset($bookmark->$field) )
79 return sanitize_bookmark_field($field, $bookmark->$field, $bookmark->link_id, $context);
83 * Retrieves the list of bookmarks
85 * Attempts to retrieve from the cache first based on MD5 hash of arguments. If
86 * that fails, then the query will be built from the arguments and executed. The
87 * results will be stored to the cache.
89 * List of default arguments are as follows:
90 * 'orderby' - Default is 'name' (string). How to order the links by. String is
91 * based off of the bookmark scheme.
92 * 'order' - Default is 'ASC' (string). Either 'ASC' or 'DESC'. Orders in either
93 * ascending or descending order.
94 * 'limit' - Default is -1 (integer) or show all. The amount of bookmarks to
96 * 'category' - Default is empty string (string). Include the links in what
98 * 'category_name' - Default is empty string (string). Get links by category
100 * 'hide_invisible' - Default is 1 (integer). Whether to show (default) or hide
101 * links marked as 'invisible'.
102 * 'show_updated' - Default is 0 (integer). Will show the time of when the
103 * bookmark was last updated.
104 * 'include' - Default is empty string (string). Include other categories
105 * separated by commas.
106 * 'exclude' - Default is empty string (string). Exclude other categories
107 * separated by commas.
110 * @uses $wpdb Database Object
111 * @link http://codex.wordpress.org/Template_Tags/get_bookmarks
113 * @param string|array $args List of arguments to overwrite the defaults
114 * @return array List of bookmark row objects
116 function get_bookmarks($args = '') {
120 'orderby' => 'name', 'order' => 'ASC',
121 'limit' => -1, 'category' => '',
122 'category_name' => '', 'hide_invisible' => 1,
123 'show_updated' => 0, 'include' => '',
124 'exclude' => '', 'search' => ''
127 $r = wp_parse_args( $args, $defaults );
128 extract( $r, EXTR_SKIP );
131 $key = md5( serialize( $r ) );
132 if ( $cache = wp_cache_get( 'get_bookmarks', 'bookmark' ) ) {
133 if ( is_array($cache) && isset( $cache[ $key ] ) )
134 return apply_filters('get_bookmarks', $cache[ $key ], $r );
137 if ( !is_array($cache) )
141 if ( !empty($include) ) {
142 $exclude = ''; //ignore exclude, category, and category_name params if using include
145 $inclinks = preg_split('/[\s,]+/',$include);
146 if ( count($inclinks) ) {
147 foreach ( $inclinks as $inclink ) {
148 if (empty($inclusions))
149 $inclusions = ' AND ( link_id = ' . intval($inclink) . ' ';
151 $inclusions .= ' OR link_id = ' . intval($inclink) . ' ';
155 if (!empty($inclusions))
159 if ( !empty($exclude) ) {
160 $exlinks = preg_split('/[\s,]+/',$exclude);
161 if ( count($exlinks) ) {
162 foreach ( $exlinks as $exlink ) {
163 if (empty($exclusions))
164 $exclusions = ' AND ( link_id <> ' . intval($exlink) . ' ';
166 $exclusions .= ' AND link_id <> ' . intval($exlink) . ' ';
170 if (!empty($exclusions))
173 if ( !empty($category_name) ) {
174 if ( $category = get_term_by('name', $category_name, 'link_category') ) {
175 $category = $category->term_id;
177 $cache[ $key ] = array();
178 wp_cache_set( 'get_bookmarks', $cache, 'bookmark' );
179 return apply_filters( 'get_bookmarks', array(), $r );
183 if ( ! empty($search) ) {
184 $search = like_escape($search);
185 $search = " AND ( (link_url LIKE '%$search%') OR (link_name LIKE '%$search%') OR (link_description LIKE '%$search%') ) ";
188 $category_query = '';
190 if ( !empty($category) ) {
191 $incategories = preg_split('/[\s,]+/',$category);
192 if ( count($incategories) ) {
193 foreach ( $incategories as $incat ) {
194 if (empty($category_query))
195 $category_query = ' AND ( tt.term_id = ' . intval($incat) . ' ';
197 $category_query .= ' OR tt.term_id = ' . intval($incat) . ' ';
201 if (!empty($category_query)) {
202 $category_query .= ") AND taxonomy = 'link_category'";
203 $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";
206 if ( $show_updated && get_option('links_recently_updated_time') ) {
207 $recently_updated_test = ", IF (DATE_ADD(link_updated, INTERVAL " . get_option('links_recently_updated_time') . " MINUTE) >= NOW(), 1,0) as recently_updated ";
209 $recently_updated_test = '';
212 $get_updated = ( $show_updated ) ? ', UNIX_TIMESTAMP(link_updated) AS link_updated_f ' : '';
214 $orderby = strtolower($orderby);
218 $length = ", CHAR_LENGTH(link_name) AS length";
224 $orderparams = array();
225 foreach ( explode(',', $orderby) as $ordparam )
226 $orderparams[] = 'link_' . trim($ordparam);
227 $orderby = implode(',', $orderparams);
230 if ( 'link_id' == $orderby )
231 $orderby = "$wpdb->links.link_id";
234 if ( $hide_invisible )
235 $visible = "AND link_visible = 'Y'";
237 $query = "SELECT * $length $recently_updated_test $get_updated FROM $wpdb->links $join WHERE 1=1 $visible $category_query";
238 $query .= " $exclusions $inclusions $search";
239 $query .= " ORDER BY $orderby $order";
241 $query .= " LIMIT $limit";
243 $results = $wpdb->get_results($query);
245 $cache[ $key ] = $results;
246 wp_cache_set( 'get_bookmarks', $cache, 'bookmark' );
248 return apply_filters('get_bookmarks', $results, $r);
252 * Sanitizes all bookmark fields
256 * @param object|array $bookmark Bookmark row
257 * @param string $context Optional, default is 'display'. How to filter the
259 * @return object|array Same type as $bookmark but with fields sanitized.
261 function sanitize_bookmark($bookmark, $context = 'display') {
262 $fields = array('link_id', 'link_url', 'link_name', 'link_image', 'link_target', 'link_category',
263 'link_description', 'link_visible', 'link_owner', 'link_rating', 'link_updated',
264 'link_rel', 'link_notes', 'link_rss', );
266 if ( is_object($bookmark) ) {
268 $link_id = $bookmark->link_id;
271 $link_id = $bookmark['link_id'];
274 foreach ( $fields as $field ) {
276 if ( isset($bookmark->$field) )
277 $bookmark->$field = sanitize_bookmark_field($field, $bookmark->$field, $link_id, $context);
279 if ( isset($bookmark[$field]) )
280 $bookmark[$field] = sanitize_bookmark_field($field, $bookmark[$field], $link_id, $context);
288 * Sanitizes a bookmark field
290 * Sanitizes the bookmark fields based on what the field name is. If the field
291 * has a strict value set, then it will be tested for that, else a more generic
292 * filtering is applied. After the more strict filter is applied, if the
293 * $context is 'raw' then the value is immediately return.
295 * Hooks exist for the more generic cases. With the 'edit' context, the
296 * 'edit_$field' filter will be called and passed the $value and $bookmark_id
297 * respectively. With the 'db' context, the 'pre_$field' filter is called and
298 * passed the value. The 'display' context is the final context and has the
299 * $field has the filter name and is passed the $value, $bookmark_id, and
300 * $context respectively.
304 * @param string $field The bookmark field
305 * @param mixed $value The bookmark field value
306 * @param int $bookmark_id Bookmark ID
307 * @param string $context How to filter the field value. Either 'raw', 'edit',
308 * 'attribute', 'js', 'db', or 'display'
309 * @return mixed The filtered value
311 function sanitize_bookmark_field($field, $value, $bookmark_id, $context) {
313 case 'link_id' : // ints
315 $value = (int) $value;
317 case 'link_category' : // array( ints )
318 $value = array_map('absint', (array) $value);
319 // We return here so that the categories aren't filtered.
320 // The 'link_category' filter is for the name of a link category, not an array of a link's link categories
323 case 'link_visible' : // bool stored as Y|N
324 $value = preg_replace('/[^YNyn]/', '', $value);
326 case 'link_target' : // "enum"
327 $targets = array('_top', '_blank');
328 if ( ! in_array($value, $targets) )
333 if ( 'raw' == $context )
336 if ( 'edit' == $context ) {
337 $format_to_edit = array('link_notes');
338 $value = apply_filters("edit_$field", $value, $bookmark_id);
340 if ( in_array($field, $format_to_edit) ) {
341 $value = format_to_edit($value);
343 $value = esc_attr($value);
345 } else if ( 'db' == $context ) {
346 $value = apply_filters("pre_$field", $value);
348 // Use display filters by default.
349 $value = apply_filters($field, $value, $bookmark_id, $context);
351 if ( 'attribute' == $context )
352 $value = esc_attr($value);
353 else if ( 'js' == $context )
354 $value = esc_js($value);
361 * Deletes bookmark cache
364 * @uses wp_cache_delete() Deletes the contents of 'get_bookmarks'
366 function clean_bookmark_cache($bookmark_id) {
367 wp_cache_delete( $bookmark_id, 'bookmark' );
368 wp_cache_delete( 'get_bookmarks', 'bookmark' );