--- a/web/wp-admin/includes/bookmark.php Thu Sep 16 15:45:36 2010 +0000
+++ b/web/wp-admin/includes/bookmark.php Mon Nov 19 18:26:13 2012 +0100
@@ -7,27 +7,27 @@
*/
/**
- * {@internal Missing Short Description}}
+ * Add a link to using values provided in $_POST.
*
- * @since unknown
+ * @since 2.0.0
*
- * @return unknown
+ * @return int|WP_Error Value 0 or WP_Error on failure. The link ID on success.
*/
function add_link() {
return edit_link();
}
/**
- * {@internal Missing Short Description}}
+ * Update or insert a link using values provided in $_POST.
*
- * @since unknown
+ * @since 2.0.0
*
- * @param unknown_type $link_id
- * @return unknown
+ * @param int $link_id Optional. ID of the link to edit.
+ * @return int|WP_Error Value 0 or WP_Error on failure. The link ID on success.
*/
-function edit_link( $link_id = '' ) {
- if (!current_user_can( 'manage_links' ))
- wp_die( __( 'Cheatin’ uh?' ));
+function edit_link( $link_id = 0 ) {
+ if ( !current_user_can( 'manage_links' ) )
+ wp_die( __( 'Cheatin’ uh?' ) );
$_POST['link_url'] = esc_html( $_POST['link_url'] );
$_POST['link_url'] = esc_url($_POST['link_url']);
@@ -39,27 +39,28 @@
if ( !empty( $link_id ) ) {
$_POST['link_id'] = $link_id;
- return wp_update_link( $_POST);
+ return wp_update_link( $_POST );
} else {
- return wp_insert_link( $_POST);
+ return wp_insert_link( $_POST );
}
}
/**
- * {@internal Missing Short Description}}
+ * Retrieve the default link for editing.
*
- * @since unknown
+ * @since 2.0.0
*
- * @return unknown
+ * @return object Default link
*/
function get_default_link_to_edit() {
+ $link = new stdClass;
if ( isset( $_GET['linkurl'] ) )
- $link->link_url = esc_url( $_GET['linkurl']);
+ $link->link_url = esc_url( $_GET['linkurl'] );
else
$link->link_url = '';
if ( isset( $_GET['name'] ) )
- $link->link_name = esc_attr( $_GET['name']);
+ $link->link_name = esc_attr( $_GET['name'] );
else
$link->link_name = '';
@@ -69,12 +70,12 @@
}
/**
- * {@internal Missing Short Description}}
+ * Delete link specified from database
*
- * @since unknown
+ * @since 2.0.0
*
- * @param unknown_type $link_id
- * @return unknown
+ * @param int $link_id ID of the link to delete
+ * @return bool True
*/
function wp_delete_link( $link_id ) {
global $wpdb;
@@ -83,7 +84,7 @@
wp_delete_object_term_relationships( $link_id, 'link_category' );
- $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->links WHERE link_id = %d", $link_id ) );
+ $wpdb->delete( $wpdb->links, array( 'link_id' => $link_id ) );
do_action( 'deleted_link', $link_id );
@@ -93,42 +94,43 @@
}
/**
- * {@internal Missing Short Description}}
+ * Retrieves the link categories associated with the link specified.
*
- * @since unknown
+ * @since 2.1.0
*
- * @param unknown_type $link_id
- * @return unknown
+ * @param int $link_id Link ID to look up
+ * @return array The requested link's categories
*/
function wp_get_link_cats( $link_id = 0 ) {
- $cats = wp_get_object_terms( $link_id, 'link_category', 'fields=ids' );
+ $cats = wp_get_object_terms( $link_id, 'link_category', array('fields' => 'ids') );
return array_unique( $cats );
}
/**
- * {@internal Missing Short Description}}
+ * Retrieve link data based on ID.
*
- * @since unknown
+ * @since 2.0.0
*
- * @param unknown_type $link_id
- * @return unknown
+ * @param int $link_id ID of link to retrieve
+ * @return object Link for editing
*/
function get_link_to_edit( $link_id ) {
return get_bookmark( $link_id, OBJECT, 'edit' );
}
/**
- * {@internal Missing Short Description}}
+ * This function inserts/updates links into/in the database.
+ *
+ * @since 2.0.0
*
- * @since unknown
- *
- * @param unknown_type $linkdata
- * @return unknown
+ * @param array $linkdata Elements that make up the link to insert.
+ * @param bool $wp_error Optional. If true return WP_Error object on failure.
+ * @return int|WP_Error Value 0 or WP_Error on failure. The link ID on success.
*/
function wp_insert_link( $linkdata, $wp_error = false ) {
- global $wpdb, $current_user;
+ global $wpdb;
$defaults = array( 'link_id' => 0, 'link_name' => '', 'link_url' => '', 'link_rating' => 0 );
@@ -166,7 +168,7 @@
$link_visible = 'Y';
if ( empty( $link_owner ) )
- $link_owner = $current_user->id;
+ $link_owner = get_current_user_id();
if ( empty( $link_notes ) )
$link_notes = '';
@@ -181,24 +183,19 @@
$link_rel = '';
// Make sure we set a valid category
- if ( ! isset( $link_category ) ||0 == count( $link_category ) || !is_array( $link_category ) ) {
+ if ( ! isset( $link_category ) || 0 == count( $link_category ) || !is_array( $link_category ) ) {
$link_category = array( get_option( 'default_link_category' ) );
}
if ( $update ) {
- if ( false === $wpdb->query( $wpdb->prepare( "UPDATE $wpdb->links SET link_url = %s,
- link_name = %s, link_image = %s, link_target = %s,
- link_visible = %s, link_description = %s, link_rating = %s,
- link_rel = %s, link_notes = %s, link_rss = %s
- WHERE link_id = %s", $link_url, $link_name, $link_image, $link_target, $link_visible, $link_description, $link_rating, $link_rel, $link_notes, $link_rss, $link_id ) ) ) {
+ 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') ) ) {
if ( $wp_error )
return new WP_Error( 'db_update_error', __( 'Could not update link in the database' ), $wpdb->last_error );
else
return 0;
}
} else {
- if ( false === $wpdb->query( $wpdb->prepare( "INSERT INTO $wpdb->links (link_url, link_name, link_image, link_target, link_description, link_visible, link_owner, link_rating, link_rel, link_notes, link_rss) VALUES(%s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s)",
- $link_url,$link_name, $link_image, $link_target, $link_description, $link_visible, $link_owner, $link_rating, $link_rel, $link_notes, $link_rss ) ) ) {
+ 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') ) ) {
if ( $wp_error )
return new WP_Error( 'db_insert_error', __( 'Could not insert link into the database' ), $wpdb->last_error );
else
@@ -220,12 +217,12 @@
}
/**
- * {@internal Missing Short Description}}
+ * Update link with the specified link categories.
*
- * @since unknown
+ * @since 2.1.0
*
- * @param unknown_type $link_id
- * @param unknown_type $link_categories
+ * @param int $link_id ID of link to update
+ * @param array $link_categories Array of categories to
*/
function wp_set_link_cats( $link_id = 0, $link_categories = array() ) {
// If $link_categories isn't already an array, make it one:
@@ -238,20 +235,20 @@
wp_set_object_terms( $link_id, $link_categories, 'link_category' );
clean_bookmark_cache( $link_id );
-} // wp_set_link_cats()
+}
/**
- * {@internal Missing Short Description}}
+ * Update a link in the database.
*
- * @since unknown
+ * @since 2.0.0
*
- * @param unknown_type $linkdata
- * @return unknown
+ * @param array $linkdata Link data to update.
+ * @return int|WP_Error Value 0 or WP_Error on failure. The updated link ID on success.
*/
function wp_update_link( $linkdata ) {
$link_id = (int) $linkdata['link_id'];
- $link = get_link( $link_id, ARRAY_A );
+ $link = get_bookmark( $link_id, ARRAY_A );
// Escape data pulled from DB.
$link = add_magic_quotes( $link );
@@ -269,5 +266,3 @@
return wp_insert_link( $linkdata );
}
-
-?>