Changeset 15564 for trunk/wp-admin/includes/comment.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/comment.php (modified) (6 diffs)

trunk/wp-admin/includes/comment.php

@@ -10 +10 @@
  * {@internal Missing Short Description}}
  *
- * @since unknown
+ * @since 2.0.0
  * @uses $wpdb
  *
- * @param string $comment_author
- * @param string $comment_date
+ * @param string $comment_author Author of the comment
+ * @param string $comment_date Date of the comment
  * @return mixed Comment ID on success.
  */
@@ -28 +28 @@
 
 /**
- * {@internal Missing Short Description}}
+ * Update a comment with values provided in $_POST.
  *
- * @since unknown
+ * @since 2.0.0
  */
 function edit_comment() {
-
     $comment_post_ID = (int) $_POST['comment_post_ID'];
 
     if (!current_user_can( 'edit_post', $comment_post_ID ))
-        wp_die( __('You are not allowed to edit comments on this post, so you cannot edit this comment.' ));
+        wp_die( __('You are not allowed to edit comments on this post, so you cannot edit this comment.' ) );
 
     $_POST['comment_author'] = $_POST['newcomment_author'];
@@ -53 +52 @@
     }
 
-    if (!empty ( $_POST['edit_date'] ) ) {
+    if ( !empty ( $_POST['edit_date'] ) ) {
         $aa = $_POST['aa'];
         $mm = $_POST['mm'];
@@ -67 +66 @@
     }
 
-    wp_update_comment( $_POST);
+    wp_update_comment( $_POST );
 }
 
@@ -73 +72 @@
  * {@internal Missing Short Description}}
  *
- * @since unknown
+ * @since 2.0.0
  *
- * @param unknown_type $id
- * @return unknown
+ * @param int $id ID of comment to retrieve
+ * @return bool|object Comment if found. False on failure.
  */
 function get_comment_to_edit( $id ) {
@@ -99 +98 @@
  * Get the number of pending comments on a post or posts
  *
- * @since unknown
+ * @since 2.3.0
  * @uses $wpdb
  *