Changeset 55855

Timestamp:

05/25/2023 10:29:39 AM (3 years ago)

Author:

spacedmonkey

Message:

Comments: Deprecate wp_queue_comments_for_comment_meta_lazyload function.

As of [55749] wp_queue_comments_for_comment_meta_lazyload is no longer used in core. This commit, deprecates this function. Update docs and tests accordingly.

Props sh4lin, spacedmonkey, costdev, peterwilsoncc.
Fixes #58301.

Location:

trunk

Files:

• src/wp-admin/includes/deprecated.php (modified) (1 diff)
• src/wp-includes/class-wp-query.php (modified) (1 diff)
• src/wp-includes/comment.php (modified) (1 diff)
• tests/phpunit/tests/query/lazyLoadCommentMeta.php (modified) (2 diffs)

trunk/src/wp-admin/includes/deprecated.php

@@ -1589 +1589 @@
         return $post;
 }
+
+/**
+ * Queues comments for metadata lazy-loading.
+ *
+ * @since 4.5.0
+ * @deprecated 6.3.0 Use wp_lazyload_comment_meta() instead.
+ *
+ * @param WP_Comment[] $comments Array of comment objects.
+ */
+function wp_queue_comments_for_comment_meta_lazyload( $comments ) {
+        _deprecated_function( __FUNCTION__, '6.3.0', 'wp_lazyload_comment_meta' );
+        // Don't use `wp_list_pluck()` to avoid by-reference manipulation.
+        $comment_ids = array();
+        if ( is_array( $comments ) ) {
+                foreach ( $comments as $comment ) {
+                        if ( $comment instanceof WP_Comment ) {
+                                $comment_ids[] = $comment->comment_ID;
+                        }
+                }
+        }
+
+        wp_lazyload_comment_meta( $comment_ids );
+}

trunk/src/wp-includes/class-wp-query.php

@@ -4892 +4892 @@
          *
          * @since 4.4.0
-         * @deprecated 4.5.0 See wp_queue_comments_for_comment_meta_lazyload().
+         * @deprecated 4.5.0 See wp_lazyload_comment_meta().
          *
          * @param mixed $check

trunk/src/wp-includes/comment.php

@@ -527 +527 @@
 
 /**
- * Queues comments for metadata lazy-loading.
- *
- * @since 4.5.0
- * @since 6.3.0 Use wp_lazyload_comment_meta() for lazy-loading of comment meta.
- *
- * @see wp_lazyload_comment_meta()
- *
- * @param WP_Comment[] $comments Array of comment objects.
- */
-function wp_queue_comments_for_comment_meta_lazyload( $comments ) {
-        // Don't use `wp_list_pluck()` to avoid by-reference manipulation.
-        $comment_ids = array();
-        if ( is_array( $comments ) ) {
-                foreach ( $comments as $comment ) {
-                        if ( $comment instanceof WP_Comment ) {
-                                $comment_ids[] = $comment->comment_ID;
-                        }
-                }
-        }
-
-        wp_lazyload_comment_meta( $comment_ids );
-}
-
-/**
  * Sets the cookies used to store an unauthenticated commentator's identity. Typically used
  * to recall previous comments by this commentator that are still held in moderation.

trunk/tests/phpunit/tests/query/lazyLoadCommentMeta.php

@@ -27 +27 @@
          *
          * @covers ::wp_queue_comments_for_comment_meta_lazyload
+         *
+         * @expectedDeprecated wp_queue_comments_for_comment_meta_lazyload
          */
         public function test_wp_queue_comments_for_comment_meta_lazyload() {
@@ -46 +48 @@
          *
          * @covers ::wp_queue_comments_for_comment_meta_lazyload
+         *
+         * @expectedDeprecated wp_queue_comments_for_comment_meta_lazyload
          */
         public function test_wp_queue_comments_for_comment_meta_lazyload_new_comment() {