Changeset 48104 for trunk/src/wp-includes/comment.php

Timestamp:

06/20/2020 12:00:07 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Capitalize "ID", when referring to a post ID, term ID, etc. in a more consistent way.

See #49572.

File:

• trunk/src/wp-includes/comment.php (modified) (13 diffs)

trunk/src/wp-includes/comment.php

@@ -1395 +1395 @@
  *
  * @param int|WP_Comment $comment_id   Comment ID or WP_Comment object.
- * @param bool           $force_delete Whether to bypass Trash and force deletion. Default is false.
+ * @param bool           $force_delete Whether to bypass Trash and force deletion. Default false.
  * @return bool True on success, false on failure.
  */
@@ -1459 +1459 @@
 
         wp_transition_comment_status( 'delete', $comment->comment_approved, $comment );
+
         return true;
 }
@@ -1509 +1510 @@
                  */
                 do_action( 'trashed_comment', $comment->comment_ID, $comment );
+
                 return true;
         }
@@ -1548 +1550 @@
                 delete_comment_meta( $comment->comment_ID, '_wp_trash_meta_time' );
                 delete_comment_meta( $comment->comment_ID, '_wp_trash_meta_status' );
+
                 /**
                  * Fires immediately after a comment is restored from the Trash.
@@ -1558 +1561 @@
                  */
                 do_action( 'untrashed_comment', $comment->comment_ID, $comment );
+
                 return true;
         }
@@ -1594 +1598 @@
                 add_comment_meta( $comment->comment_ID, '_wp_trash_meta_status', $comment->comment_approved );
                 add_comment_meta( $comment->comment_ID, '_wp_trash_meta_time', time() );
+
                 /**
                  * Fires immediately after a comment is marked as Spam.
@@ -1604 +1609 @@
                  */
                 do_action( 'spammed_comment', $comment->comment_ID, $comment );
+
                 return true;
         }
@@ -1643 +1649 @@
                 delete_comment_meta( $comment->comment_ID, '_wp_trash_meta_status' );
                 delete_comment_meta( $comment->comment_ID, '_wp_trash_meta_time' );
+
                 /**
                  * Fires immediately after a comment is unmarked as Spam.
@@ -1653 +1660 @@
                  */
                 do_action( 'unspammed_comment', $comment->comment_ID, $comment );
+
                 return true;
         }
@@ -1986 +1994 @@
         if ( isset( $commentdata['user_ID'] ) ) {
                 /**
-                 * Filters the comment author's user id before it is set.
+                 * Filters the comment author's user ID before it is set.
                  *
                  * The first time this filter is evaluated, 'user_ID' is checked
@@ -2280 +2288 @@
  * @param int|WP_Comment $comment_id     Comment ID or WP_Comment object.
  * @param string         $comment_status New comment status, either 'hold', 'approve', 'spam', or 'trash'.
- * @param bool           $wp_error       Whether to return a WP_Error object if there is a failure. Default is false.
+ * @param bool           $wp_error       Whether to return a WP_Error object if there is a failure. Default false.
  * @return bool|WP_Error True on success, false or WP_Error on failure.
  */
@@ -2428 +2436 @@
         clean_comment_cache( $comment_ID );
         wp_update_comment_count( $comment_post_ID );
+
         /**
          * Fires immediately after a comment is updated in the database.
@@ -2440 +2449 @@
          */
         do_action( 'edit_comment', $comment_ID, $data );
+
         $comment = get_comment( $comment_ID );
+
         wp_transition_comment_status( $comment->comment_approved, $old_status, $comment );
+
         return $rval;
 }