Changeset 48140

Timestamp:

06/23/2020 01:51:03 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Comments: Remove wp_get_include_unapproved_comments_argument() for now.

The function seems too specific and low-level for an abstraction, is only used in two places, and does not provide a significant benefit in terms of reducing code duplication.

Follow-up to [48133].

See #8973.

Location:

trunk/src/wp-includes

Files:

• comment-template.php (modified) (3 diffs)
• comment.php (modified) (5 diffs)

trunk/src/wp-includes/comment-template.php

@@ -1331 +1331 @@
  *
  * @since 1.5.0
- * @since 5.5.0 Removed the need to use the $user_ID global.
  *
  * @global WP_Query   $wp_query         WordPress Query object.
@@ -1397 +1396 @@
         }
 
-        $include_unapproved = wp_get_include_unapproved_comments_argument();
-        if ( $include_unapproved ) {
-                $comment_args['include_unapproved'] = $include_unapproved;
+        if ( is_user_logged_in() ) {
+                $comment_args['include_unapproved'] = array( get_current_user_id() );
+        } else {
+                $unapproved_email = wp_get_unapproved_comment_author_email();
+
+                if ( $unapproved_email ) {
+                        $comment_args['include_unapproved'] = array( $unapproved_email );
+                }
         }
 
@@ -2098 +2102 @@
 
                                 if ( is_user_logged_in() ) {
-                                        $comment_args['include_unapproved'] = get_current_user_id();
+                                        $comment_args['include_unapproved'] = array( get_current_user_id() );
                                 } else {
                                         $unapproved_email = wp_get_unapproved_comment_author_email();

trunk/src/wp-includes/comment.php

@@ -1055 +1055 @@
  * @param array $args {
  *      Array of optional arguments.
- *      @type string     $type      Limit paginated comments to those matching a given type. Accepts 'comment',
- *                                  'trackback', 'pingback', 'pings' (trackbacks and pingbacks), or 'all'.
- *                                  Default is 'all'.
- *      @type int        $per_page  Per-page count to use when calculating pagination. Defaults to the value of the
- *                                  'comments_per_page' option.
- *      @type int|string $max_depth If greater than 1, comment page will be determined for the top-level parent of
- *                                  `$comment_ID`. Defaults to the value of the 'thread_comments_depth' option.
+ *      @type string     $type      Limit paginated comments to those matching a given type.
+ *                                  Accepts 'comment', 'trackback', 'pingback', 'pings'
+ *                                  (trackbacks and pingbacks), or 'all'. Default 'all'.
+ *      @type int        $per_page  Per-page count to use when calculating pagination.
+ *                                  Defaults to the value of the 'comments_per_page' option.
+ *      @type int|string $max_depth If greater than 1, comment page will be determined
+ *                                  for the top-level parent `$comment_ID`.
+ *                                  Defaults to the value of the 'thread_comments_depth' option.
  * } *
  * @return int|null Comment page number or null on error.
@@ -1133 +1134 @@
                 );
 
-                $include_unapproved = wp_get_include_unapproved_comments_argument();
-                if ( $include_unapproved ) {
-                        $comment_args['include_unapproved'] = $include_unapproved;
+                if ( is_user_logged_in() ) {
+                        $comment_args['include_unapproved'] = array( get_current_user_id() );
+                } else {
+                        $unapproved_email = wp_get_unapproved_comment_author_email();
+
+                        if ( $unapproved_email ) {
+                                $comment_args['include_unapproved'] = array( $unapproved_email );
+                        }
                 }
 
@@ -1148 +1154 @@
                  *     Array of WP_Comment_Query arguments.
                  *
-                 *     @type string $type               Limit paginated comments to those matching a given type. Accepts 'comment',
-                 *                                      'trackback', 'pingback', 'pings' (trackbacks and pingbacks), or 'all'.
-                 *                                      Default is 'all'.
+                 *     @type string $type               Limit paginated comments to those matching a given type.
+                 *                                      Accepts 'comment', 'trackback', 'pingback', 'pings'
+                 *                                      (trackbacks and pingbacks), or 'all'. Default 'all'.
                  *     @type int    $post_id            ID of the post.
                  *     @type string $fields             Comment fields to return.
-                 *     @type bool   $count              Whether to return a comment count (true) or array of
-                 *                                      comment objects (false)
+                 *     @type bool   $count              Whether to return a comment count (true) or array
+                 *                                      of comment objects (false).
                  *     @type string $status             Comment status.
                  *     @type int    $parent             Parent ID of comment to retrieve children of.
@@ -1162 +1168 @@
                  * }
                  */
-                $comment_args        = apply_filters( 'get_page_of_comment_query_args', $comment_args );
+                $comment_args = apply_filters( 'get_page_of_comment_query_args', $comment_args );
+
                 $comment_query       = new WP_Comment_Query();
                 $older_comment_count = $comment_query->query( $comment_args );
@@ -1925 +1932 @@
 
         return $commenter_email;
-}
-
-/**
- * Get include unapproved comments query argument.
- *
- * Used to include unapproved comments of currrent commenters to
- * keep them informed their comments were successfully saved.
- *
- * @since 5.5.0
- *
- * @return array The unapproved comments query argument.
- */
-function wp_get_include_unapproved_comments_argument() {
-        $user_id            = get_current_user_id();
-        $include_unapproved = array();
-
-        if ( $user_id ) {
-                $include_unapproved = array( $user_id );
-        } else {
-                $unapproved_email = wp_get_unapproved_comment_author_email();
-
-                if ( $unapproved_email ) {
-                        $include_unapproved = array( $unapproved_email );
-                }
-        }
-
-        return $include_unapproved;
 }