Wordpress 3.1.1

[autoinstalls/wordpress.git] / wp-admin / includes / bookmark.php

diff --git a/wp-admin/includes/bookmark.php b/wp-admin/includes/bookmark.php
index 7dd8baf65130804c4507a3732abbe1748f9b2809..0ed560c1913986eed2f7506625e7b1d5f6f49478 100644 (file)
--- a/wp-admin/includes/bookmark.php
+++ b/wp-admin/includes/bookmark.php
@@ -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,27 @@ function edit_link( $link_id = '' ) {
 
        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() {
        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 +69,12 @@ function get_default_link_to_edit() {
 }
 
 /**
- * {@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;
@@ -93,12 +93,12 @@ function wp_delete_link( $link_id ) {
 }
 
 /**
- * {@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 ) {
 
@@ -108,27 +108,28 @@ function wp_get_link_cats( $link_id = 0 ) {
 }
 
 /**
- * {@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 unknown
+ * @since 2.0.0
  *
- * @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 +167,7 @@ function wp_insert_link( $linkdata, $wp_error = false ) {
                $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,7 +182,7 @@ function wp_insert_link( $linkdata, $wp_error = false ) {
                $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' ) );
        }
 
@@ -215,12 +216,12 @@ function wp_insert_link( $linkdata, $wp_error = false ) {
 }
 
 /**
- * {@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:
@@ -233,15 +234,15 @@ function wp_set_link_cats( $link_id = 0, $link_categories = array() ) {
        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'];