3 * WordPress Bookmark Administration API
6 * @subpackage Administration
10 * Add a link to using values provided in $_POST.
14 * @return int|WP_Error Value 0 or WP_Error on failure. The link ID on success.
21 * Updates or inserts a link using values provided in $_POST.
25 * @param int $link_id Optional. ID of the link to edit. Default 0.
26 * @return int|WP_Error Value 0 or WP_Error on failure. The link ID on success.
28 function edit_link( $link_id = 0 ) {
29 if ( ! current_user_can( 'manage_links' ) ) {
31 '<h1>' . __( 'Cheatin’ uh?' ) . '</h1>' .
32 '<p>' . __( 'You do not have sufficient permissions to edit the links for this site.' ) . '</p>',
37 $_POST['link_url'] = esc_html( $_POST['link_url'] );
38 $_POST['link_url'] = esc_url($_POST['link_url']);
39 $_POST['link_name'] = esc_html( $_POST['link_name'] );
40 $_POST['link_image'] = esc_html( $_POST['link_image'] );
41 $_POST['link_rss'] = esc_url($_POST['link_rss']);
42 if ( !isset($_POST['link_visible']) || 'N' != $_POST['link_visible'] )
43 $_POST['link_visible'] = 'Y';
45 if ( !empty( $link_id ) ) {
46 $_POST['link_id'] = $link_id;
47 return wp_update_link( $_POST );
49 return wp_insert_link( $_POST );
54 * Retrieves the default link for editing.
58 * @return stdClass Default link object.
60 function get_default_link_to_edit() {
62 if ( isset( $_GET['linkurl'] ) )
63 $link->link_url = esc_url( wp_unslash( $_GET['linkurl'] ) );
67 if ( isset( $_GET['name'] ) )
68 $link->link_name = esc_attr( wp_unslash( $_GET['name'] ) );
70 $link->link_name = '';
72 $link->link_visible = 'Y';
78 * Deletes a specified link from the database.
82 * @global wpdb $wpdb WordPress database abstraction object.
84 * @param int $link_id ID of the link to delete
85 * @return true Always true.
87 function wp_delete_link( $link_id ) {
90 * Fires before a link is deleted.
94 * @param int $link_id ID of the link to delete.
96 do_action( 'delete_link', $link_id );
98 wp_delete_object_term_relationships( $link_id, 'link_category' );
100 $wpdb->delete( $wpdb->links, array( 'link_id' => $link_id ) );
103 * Fires after a link has been deleted.
107 * @param int $link_id ID of the deleted link.
109 do_action( 'deleted_link', $link_id );
111 clean_bookmark_cache( $link_id );
117 * Retrieves the link categories associated with the link specified.
121 * @param int $link_id Link ID to look up
122 * @return array The requested link's categories
124 function wp_get_link_cats( $link_id = 0 ) {
125 $cats = wp_get_object_terms( $link_id, 'link_category', array('fields' => 'ids') );
126 return array_unique( $cats );
130 * Retrieves link data based on its ID.
134 * @param int $link_id ID of link to retrieve.
135 * @return object Link object for editing.
137 function get_link_to_edit( $link_id ) {
138 return get_bookmark( $link_id, OBJECT, 'edit' );
142 * Inserts/updates links into/in the database.
146 * @global wpdb $wpdb WordPress database abstraction object.
148 * @param array $linkdata Elements that make up the link to insert.
149 * @param bool $wp_error Optional. Whether to return a WP_Error object on failure. Default false.
150 * @return int|WP_Error Value 0 or WP_Error on failure. The link ID on success.
152 function wp_insert_link( $linkdata, $wp_error = false ) {
155 $defaults = array( 'link_id' => 0, 'link_name' => '', 'link_url' => '', 'link_rating' => 0 );
157 $args = wp_parse_args( $linkdata, $defaults );
158 $r = wp_unslash( sanitize_bookmark( $args, 'db' ) );
160 $link_id = $r['link_id'];
161 $link_name = $r['link_name'];
162 $link_url = $r['link_url'];
165 if ( ! empty( $link_id ) ) {
169 if ( trim( $link_name ) == '' ) {
170 if ( trim( $link_url ) != '' ) {
171 $link_name = $link_url;
177 if ( trim( $link_url ) == '' ) {
181 $link_rating = ( ! empty( $r['link_rating'] ) ) ? $r['link_rating'] : 0;
182 $link_image = ( ! empty( $r['link_image'] ) ) ? $r['link_image'] : '';
183 $link_target = ( ! empty( $r['link_target'] ) ) ? $r['link_target'] : '';
184 $link_visible = ( ! empty( $r['link_visible'] ) ) ? $r['link_visible'] : 'Y';
185 $link_owner = ( ! empty( $r['link_owner'] ) ) ? $r['link_owner'] : get_current_user_id();
186 $link_notes = ( ! empty( $r['link_notes'] ) ) ? $r['link_notes'] : '';
187 $link_description = ( ! empty( $r['link_description'] ) ) ? $r['link_description'] : '';
188 $link_rss = ( ! empty( $r['link_rss'] ) ) ? $r['link_rss'] : '';
189 $link_rel = ( ! empty( $r['link_rel'] ) ) ? $r['link_rel'] : '';
190 $link_category = ( ! empty( $r['link_category'] ) ) ? $r['link_category'] : array();
192 // Make sure we set a valid category.
193 if ( ! is_array( $link_category ) || 0 == count( $link_category ) ) {
194 $link_category = array( get_option( 'default_link_category' ) );
198 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' ) ) ) {
200 return new WP_Error( 'db_update_error', __( 'Could not update link in the database' ), $wpdb->last_error );
206 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' ) ) ) {
208 return new WP_Error( 'db_insert_error', __( 'Could not insert link into the database' ), $wpdb->last_error );
213 $link_id = (int) $wpdb->insert_id;
216 wp_set_link_cats( $link_id, $link_category );
220 * Fires after a link was updated in the database.
224 * @param int $link_id ID of the link that was updated.
226 do_action( 'edit_link', $link_id );
229 * Fires after a link was added to the database.
233 * @param int $link_id ID of the link that was added.
235 do_action( 'add_link', $link_id );
237 clean_bookmark_cache( $link_id );
243 * Update link with the specified link categories.
247 * @param int $link_id ID of the link to update.
248 * @param array $link_categories Array of link categories to add the link to.
250 function wp_set_link_cats( $link_id = 0, $link_categories = array() ) {
251 // If $link_categories isn't already an array, make it one:
252 if ( !is_array( $link_categories ) || 0 == count( $link_categories ) )
253 $link_categories = array( get_option( 'default_link_category' ) );
255 $link_categories = array_map( 'intval', $link_categories );
256 $link_categories = array_unique( $link_categories );
258 wp_set_object_terms( $link_id, $link_categories, 'link_category' );
260 clean_bookmark_cache( $link_id );
264 * Updates a link in the database.
268 * @param array $linkdata Link data to update.
269 * @return int|WP_Error Value 0 or WP_Error on failure. The updated link ID on success.
271 function wp_update_link( $linkdata ) {
272 $link_id = (int) $linkdata['link_id'];
274 $link = get_bookmark( $link_id, ARRAY_A );
276 // Escape data pulled from DB.
277 $link = wp_slash( $link );
279 // Passed link category list overwrites existing category list if not empty.
280 if ( isset( $linkdata['link_category'] ) && is_array( $linkdata['link_category'] )
281 && 0 != count( $linkdata['link_category'] ) )
282 $link_cats = $linkdata['link_category'];
284 $link_cats = $link['link_category'];
286 // Merge old and new fields with new fields overwriting old ones.
287 $linkdata = array_merge( $link, $linkdata );
288 $linkdata['link_category'] = $link_cats;
290 return wp_insert_link( $linkdata );
294 * Outputs the 'disabled' message for the WordPress Link Manager.
299 * @global string $pagenow
301 function wp_link_manager_disabled_message() {
303 if ( 'link-manager.php' != $pagenow && 'link-add.php' != $pagenow && 'link.php' != $pagenow )
306 add_filter( 'pre_option_link_manager_enabled', '__return_true', 100 );
307 $really_can_manage_links = current_user_can( 'manage_links' );
308 remove_filter( 'pre_option_link_manager_enabled', '__return_true', 100 );
310 if ( $really_can_manage_links && current_user_can( 'install_plugins' ) ) {
311 $link = network_admin_url( 'plugin-install.php?tab=search&s=Link+Manager' );
312 wp_die( sprintf( __( 'If you are looking to use the link manager, please install the <a href="%s">Link Manager</a> plugin.' ), $link ) );
315 wp_die( __( 'You do not have sufficient permissions to edit the links for this site.' ) );