Changeset 44941 for trunk/tests/phpunit/tests/post/getTheExcerpt.php

Timestamp:

03/20/2019 03:48:46 PM (8 years ago)

Author:

boonebgorges

Message:

Posts: Avoid the use of globals in get_the_content() and related functions.

This changeset introduces $post parameters to get_the_content() and
wp_trim_excerpt(). When a $post object is passed to one of these functions,
the functions will operate on the data from that object, rather than from the
post globals ($authordata, $page, etc). This ensures that the functions work
in a predictable manner when used outside of the regular post loop.

The global-mismatch problem is surfaced in cases where get_the_excerpt() is
called outside of the post loop, on posts that don't have a defined excerpt. In
these cases, the post globals - used to generate a fallback excerpt - may refer
to the incorrect object, resulting in PHP notices or other unpredictable
behavior. See #36934 for a related issue.

Props spacedmonkey, kraftbj, Shital Patel.
Fixes #42814.

File:

• trunk/tests/phpunit/tests/post/getTheExcerpt.php (modified) (1 diff)

trunk/tests/phpunit/tests/post/getTheExcerpt.php

@@ -58 +58 @@
                 $this->assertSame( 'Bar', get_the_excerpt( $post_id ) );
         }
+
+        /**
+         * @ticket 42814
+         */
+        public function test_should_fall_back_on_post_content_if_excerpt_is_empty_and_post_is_inferred_from_context() {
+                $post_id = self::factory()->post->create(
+                        array(
+                                'post_content' => 'Foo',
+                                'post_excerpt' => '',
+                        )
+                );
+
+                $q = new WP_Query(
+                        array(
+                                'p' => $post_id,
+                        )
+                );
+
+                while ( $q->have_posts() ) {
+                        $q->the_post();
+                        $found = get_the_excerpt();
+                }
+
+                $this->assertSame( 'Foo', $found );
+        }
+
+        /**
+         * @ticket 42814
+         */
+        public function test_should_fall_back_on_post_content_if_excerpt_is_empty_and_post_is_provided() {
+                $GLOBALS['post'] = self::factory()->post->create_and_get(
+                        array(
+                                'post_content' => 'Foo',
+                                'post_excerpt' => '',
+                        )
+                );
+                $this->assertSame( 'Foo', get_the_excerpt( $GLOBALS['post'] ) );
+        }
+
+        /**
+         * @ticket 42814
+         */
+        public function test_should_respect_post_parameter_in_the_loop() {
+                $p1 = self::factory()->post->create_and_get( array( 'post_excerpt' => 'Foo' ) );
+                $p2 = self::factory()->post->create_and_get( array( 'post_excerpt' => 'Bar' ) );
+                $q  = new WP_Query(
+                        array(
+                                'p' => $p1->ID,
+                        )
+                );
+
+                while ( $q->have_posts() ) {
+                        $q->the_post();
+                        $found = get_the_excerpt( $p2 );
+                }
+
+                $this->assertSame( 'Bar', $found );
+        }
+
+        /**
+         * @ticket 42814
+         */
+        public function test_should_respect_post_parameter_in_the_loop_when_falling_back_on_post_content() {
+                $p1 = self::factory()->post->create_and_get(
+                        array(
+                                'post_content' => 'Foo',
+                                'post_excerpt' => '',
+                        )
+                );
+                $p2 = self::factory()->post->create_and_get(
+                        array(
+                                'post_content' => 'Bar',
+                                'post_excerpt' => '',
+                        )
+                );
+                $q  = new WP_Query(
+                        array(
+                                'p' => $p1->ID,
+                        )
+                );
+
+                while ( $q->have_posts() ) {
+                        $q->the_post();
+                        $found = get_the_excerpt( $p2 );
+                }
+
+                $this->assertSame( 'Bar', $found );
+        }
 }