Changeset 15564 for trunk/wp-admin/includes/bookmark.php

Timestamp:

09/05/2010 02:45:39 AM (14 years ago)

Author:

nacin

Message:

phpdoc, @since, whitespace. Also require an argument in wp_insert_post(). props duck_, see #14783.

File:

• trunk/wp-admin/includes/bookmark.php (modified) (10 diffs)

trunk/wp-admin/includes/bookmark.php

@@ -8 +8 @@
 
 /**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- *
- * @return unknown
+ * Add a link to using values provided in $_POST.
+ *
+ * @since 2.0.0
+ *
+ * @return int|WP_Error Value 0 or WP_Error on failure. The link ID on success.
  */
 function add_link() {
@@ -19 +19 @@
 
 /**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- *
- * @param unknown_type $link_id
- * @return unknown
- */
-function edit_link( $link_id = '' ) {
-    if (!current_user_can( 'manage_links' ))
-        wp_die( __( 'Cheatin’ uh?' ));
+ * Update or insert a link using values provided in $_POST.
+ *
+ * @since 2.0.0
+ *
+ * @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 = 0 ) {
+    if ( !current_user_can( 'manage_links' ) )
+        wp_die( __( 'Cheatin’ uh?' ) );
 
     $_POST['link_url'] = esc_html( $_POST['link_url'] );
@@ -40 +40 @@
     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);
-    }
-}
-
-/**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- *
- * @return unknown
+        return wp_insert_link( $_POST );
+    }
+}
+
+/**
+ * Retrieve the default link for editing.
+ *
+ * @since 2.0.0
+ *
+ * @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 = '';
@@ -70 +70 @@
 
 /**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- *
- * @param unknown_type $link_id
- * @return unknown
+ * Delete link specified from database
+ *
+ * @since 2.0.0
+ *
+ * @param int $link_id ID of the link to delete
+ * @return bool True
  */
 function wp_delete_link( $link_id ) {
@@ -94 +94 @@
 
 /**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- *
- * @param unknown_type $link_id
- * @return unknown
+ * Retrieves the link categories associated with the link specified.
+ *
+ * @since 2.1.0
+ *
+ * @param int $link_id Link ID to look up
+ * @return array The requested link's categories
  */
 function wp_get_link_cats( $link_id = 0 ) {
@@ -109 +109 @@
 
 /**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- *
- * @param unknown_type $link_id
- * @return unknown
+ * Retrieve link data based on ID.
+ *
+ * @since 2.0.0
+ *
+ * @param int $link_id ID of link to retrieve
+ * @return object Link for editing
  */
 function get_link_to_edit( $link_id ) {
@@ -121 +121 @@
 
 /**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- *
- * @param unknown_type $linkdata
- * @return unknown
+ * This function inserts/updates links into/in the database. 
+ *
+ * @since 2.0.0
+ *
+ * @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 ) {
@@ -182 +183 @@
 
     // 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' ) );
     }
@@ -216 +217 @@
 
 /**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- *
- * @param unknown_type $link_id
- * @param unknown_type $link_categories
+ * Update link with the specified link categories.
+ *
+ * @since 2.1.0
+ *
+ * @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() ) {
@@ -234 +235 @@
 
     clean_bookmark_cache( $link_id );
-}   // wp_set_link_cats()
-
-/**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- *
- * @param unknown_type $linkdata
- * @return unknown
+}
+
+/**
+ * Update a link in the database.
+ *
+ * @since 2.0.0
+ *
+ * @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 ) {