Changeset 54488

Timestamp:

10/11/2022 03:43:04 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Comments: Return early from comment_form() if an invalid post ID is passed.

If an invalid post ID is passed to the function, comments_open() should return false, and no comment form be displayed. This commit restores the previous behavior that was unintentionally changed when standardizing on the $post parameter name.

Follow-up to [53715].

Props peterwilsoncc.
Fixes #56243.

Location:

trunk

Files:

• src/wp-includes/comment-template.php (modified) (2 diffs)
• tests/phpunit/tests/comment/commentForm.php (modified) (1 diff)

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

@@ -2325 +2325 @@
         $post = get_post( $post );
 
-        $post_id = $post ? $post->ID : get_the_ID();
-
-        // Exit the function when comments for the post are closed.
-        if ( ! comments_open( $post_id ) ) {
+        // Exit the function if the post is invalid or comments are closed.
+        if ( ! $post || ! comments_open( $post ) ) {
                 /**
                  * Fires after the comment form if comments are closed.
+                 *
+                 * For backward compatibility, this action also fires if comment_form()
+                 * is called with an invalid post object or ID.
                  *
                  * @since 3.0.0
@@ -2339 +2340 @@
         }
 
+        $post_id       = $post->ID;
         $commenter     = wp_get_current_commenter();
         $user          = wp_get_current_user();

trunk/tests/phpunit/tests/comment/commentForm.php

@@ -154 +154 @@
                 $this->assertStringNotContainsString( $expected, $form );
         }
+
+        /**
+         * @ticket 56243
+         */
+        public function test_comment_form_should_not_display_for_global_post_when_called_with_invalid_id() {
+                // Go to permalink to ensure global post ID is set.
+                $this->go_to( get_permalink( self::$post_id ) );
+
+                $impossibly_high_post_id = PHP_INT_MAX;
+
+                $form = get_echo( 'comment_form', array( array(), $impossibly_high_post_id ) );
+                $this->assertEmpty( $form );
+        }
+
+        /**
+         * @ticket 56243
+         */
+        public function test_comment_form_should_display_for_global_post_with_falsey_post_id() {
+                $post_id = self::$post_id;
+                $this->go_to( get_permalink( $post_id ) );
+
+                $form = get_echo( 'comment_form', array( array(), false ) );
+                $this->assertNotEmpty( $form );
+
+                $post_hidden_field = "<input type='hidden' name='comment_post_ID' value='{$post_id}' id='comment_post_ID' />";
+                $this->assertStringContainsString( $post_hidden_field, $form );
+        }
+
+        /**
+         * @ticket 56243
+         */
+        public function test_comment_form_should_display_for_specified_post_when_passed_a_valid_post_id() {
+                $post_id = self::$post_id;
+
+                $form = get_echo( 'comment_form', array( array(), $post_id ) );
+                $this->assertNotEmpty( $form );
+
+                $post_hidden_field = "<input type='hidden' name='comment_post_ID' value='{$post_id}' id='comment_post_ID' />";
+                $this->assertStringContainsString( $post_hidden_field, $form );
+        }
 }