WordPress 3.4
[autoinstalls/wordpress.git] / wp-admin / includes / bookmark.php
1 <?php
2 /**
3  * WordPress Bookmark Administration API
4  *
5  * @package WordPress
6  * @subpackage Administration
7  */
8
9 /**
10  * Add a link to using values provided in $_POST.
11  *
12  * @since 2.0.0
13  *
14  * @return int|WP_Error Value 0 or WP_Error on failure. The link ID on success.
15  */
16 function add_link() {
17         return edit_link();
18 }
19
20 /**
21  * Update or insert a link using values provided in $_POST.
22  *
23  * @since 2.0.0
24  *
25  * @param int $link_id Optional. ID of the link to edit.
26  * @return int|WP_Error Value 0 or WP_Error on failure. The link ID on success.
27  */
28 function edit_link( $link_id = 0 ) {
29         if ( !current_user_can( 'manage_links' ) )
30                 wp_die( __( 'Cheatin&#8217; uh?' ) );
31
32         $_POST['link_url'] = esc_html( $_POST['link_url'] );
33         $_POST['link_url'] = esc_url($_POST['link_url']);
34         $_POST['link_name'] = esc_html( $_POST['link_name'] );
35         $_POST['link_image'] = esc_html( $_POST['link_image'] );
36         $_POST['link_rss'] = esc_url($_POST['link_rss']);
37         if ( !isset($_POST['link_visible']) || 'N' != $_POST['link_visible'] )
38                 $_POST['link_visible'] = 'Y';
39
40         if ( !empty( $link_id ) ) {
41                 $_POST['link_id'] = $link_id;
42                 return wp_update_link( $_POST );
43         } else {
44                 return wp_insert_link( $_POST );
45         }
46 }
47
48 /**
49  * Retrieve the default link for editing.
50  *
51  * @since 2.0.0
52  *
53  * @return object Default link
54  */
55 function get_default_link_to_edit() {
56         $link = new stdClass;
57         if ( isset( $_GET['linkurl'] ) )
58                 $link->link_url = esc_url( $_GET['linkurl'] );
59         else
60                 $link->link_url = '';
61
62         if ( isset( $_GET['name'] ) )
63                 $link->link_name = esc_attr( $_GET['name'] );
64         else
65                 $link->link_name = '';
66
67         $link->link_visible = 'Y';
68
69         return $link;
70 }
71
72 /**
73  * Delete link specified from database
74  *
75  * @since 2.0.0
76  *
77  * @param int $link_id ID of the link to delete
78  * @return bool True
79  */
80 function wp_delete_link( $link_id ) {
81         global $wpdb;
82
83         do_action( 'delete_link', $link_id );
84
85         wp_delete_object_term_relationships( $link_id, 'link_category' );
86
87         $wpdb->delete( $wpdb->links, array( 'link_id' => $link_id ) );
88
89         do_action( 'deleted_link', $link_id );
90
91         clean_bookmark_cache( $link_id );
92
93         return true;
94 }
95
96 /**
97  * Retrieves the link categories associated with the link specified.
98  *
99  * @since 2.1.0
100  *
101  * @param int $link_id Link ID to look up
102  * @return array The requested link's categories
103  */
104 function wp_get_link_cats( $link_id = 0 ) {
105
106         $cats = wp_get_object_terms( $link_id, 'link_category', array('fields' => 'ids') );
107
108         return array_unique( $cats );
109 }
110
111 /**
112  * Retrieve link data based on ID.
113  *
114  * @since 2.0.0
115  *
116  * @param int $link_id ID of link to retrieve
117  * @return object Link for editing
118  */
119 function get_link_to_edit( $link_id ) {
120         return get_bookmark( $link_id, OBJECT, 'edit' );
121 }
122
123 /**
124  * This function inserts/updates links into/in the database.
125  *
126  * @since 2.0.0
127  *
128  * @param array $linkdata Elements that make up the link to insert.
129  * @param bool $wp_error Optional. If true return WP_Error object on failure.
130  * @return int|WP_Error Value 0 or WP_Error on failure. The link ID on success.
131  */
132 function wp_insert_link( $linkdata, $wp_error = false ) {
133         global $wpdb;
134
135         $defaults = array( 'link_id' => 0, 'link_name' => '', 'link_url' => '', 'link_rating' => 0 );
136
137         $linkdata = wp_parse_args( $linkdata, $defaults );
138         $linkdata = sanitize_bookmark( $linkdata, 'db' );
139
140         extract( stripslashes_deep( $linkdata ), EXTR_SKIP );
141
142         $update = false;
143
144         if ( !empty( $link_id ) )
145                 $update = true;
146
147         if ( trim( $link_name ) == '' ) {
148                 if ( trim( $link_url ) != '' ) {
149                         $link_name = $link_url;
150                 } else {
151                         return 0;
152                 }
153         }
154
155         if ( trim( $link_url ) == '' )
156                 return 0;
157
158         if ( empty( $link_rating ) )
159                 $link_rating = 0;
160
161         if ( empty( $link_image ) )
162                 $link_image = '';
163
164         if ( empty( $link_target ) )
165                 $link_target = '';
166
167         if ( empty( $link_visible ) )
168                 $link_visible = 'Y';
169
170         if ( empty( $link_owner ) )
171                 $link_owner = get_current_user_id();
172
173         if ( empty( $link_notes ) )
174                 $link_notes = '';
175
176         if ( empty( $link_description ) )
177                 $link_description = '';
178
179         if ( empty( $link_rss ) )
180                 $link_rss = '';
181
182         if ( empty( $link_rel ) )
183                 $link_rel = '';
184
185         // Make sure we set a valid category
186         if ( ! isset( $link_category ) || 0 == count( $link_category ) || !is_array( $link_category ) ) {
187                 $link_category = array( get_option( 'default_link_category' ) );
188         }
189
190         if ( $update ) {
191                 if ( false === $wpdb->update( $wpdb->links, compact('link_url', 'link_name', 'link_image', 'link_target', 'link_description', 'link_visible', 'link_rating', 'link_rel', 'link_notes', 'link_rss'), compact('link_id') ) ) {
192                         if ( $wp_error )
193                                 return new WP_Error( 'db_update_error', __( 'Could not update link in the database' ), $wpdb->last_error );
194                         else
195                                 return 0;
196                 }
197         } else {
198                 if ( false === $wpdb->insert( $wpdb->links, compact('link_url', 'link_name', 'link_image', 'link_target', 'link_description', 'link_visible', 'link_owner', 'link_rating', 'link_rel', 'link_notes', 'link_rss') ) ) {
199                         if ( $wp_error )
200                                 return new WP_Error( 'db_insert_error', __( 'Could not insert link into the database' ), $wpdb->last_error );
201                         else
202                                 return 0;
203                 }
204                 $link_id = (int) $wpdb->insert_id;
205         }
206
207         wp_set_link_cats( $link_id, $link_category );
208
209         if ( $update )
210                 do_action( 'edit_link', $link_id );
211         else
212                 do_action( 'add_link', $link_id );
213
214         clean_bookmark_cache( $link_id );
215
216         return $link_id;
217 }
218
219 /**
220  * Update link with the specified link categories.
221  *
222  * @since 2.1.0
223  *
224  * @param int $link_id ID of link to update
225  * @param array $link_categories Array of categories to
226  */
227 function wp_set_link_cats( $link_id = 0, $link_categories = array() ) {
228         // If $link_categories isn't already an array, make it one:
229         if ( !is_array( $link_categories ) || 0 == count( $link_categories ) )
230                 $link_categories = array( get_option( 'default_link_category' ) );
231
232         $link_categories = array_map( 'intval', $link_categories );
233         $link_categories = array_unique( $link_categories );
234
235         wp_set_object_terms( $link_id, $link_categories, 'link_category' );
236
237         clean_bookmark_cache( $link_id );
238 }
239
240 /**
241  * Update a link in the database.
242  *
243  * @since 2.0.0
244  *
245  * @param array $linkdata Link data to update.
246  * @return int|WP_Error Value 0 or WP_Error on failure. The updated link ID on success.
247  */
248 function wp_update_link( $linkdata ) {
249         $link_id = (int) $linkdata['link_id'];
250
251         $link = get_bookmark( $link_id, ARRAY_A );
252
253         // Escape data pulled from DB.
254         $link = add_magic_quotes( $link );
255
256         // Passed link category list overwrites existing category list if not empty.
257         if ( isset( $linkdata['link_category'] ) && is_array( $linkdata['link_category'] )
258                          && 0 != count( $linkdata['link_category'] ) )
259                 $link_cats = $linkdata['link_category'];
260         else
261                 $link_cats = $link['link_category'];
262
263         // Merge old and new fields with new fields overwriting old ones.
264         $linkdata = array_merge( $link, $linkdata );
265         $linkdata['link_category'] = $link_cats;
266
267         return wp_insert_link( $linkdata );
268 }