Changeset 44941 for trunk/src/wp-includes/class-wp-query.php

Timestamp:

03/20/2019 03:48:46 PM (6 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/src/wp-includes/class-wp-query.php (modified) (2 diffs)

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

@@ -4156 +4156 @@
         }
 
+        $elements = $this->generate_postdata( $post );
+        if ( false === $elements ) {
+            return;
+        }
+
+        $id           = $elements['id'];
+        $authordata   = $elements['authordata'];
+        $currentday   = $elements['currentday'];
+        $currentmonth = $elements['currentmonth'];
+        $page         = $elements['page'];
+        $pages        = $elements['pages'];
+        $multipage    = $elements['multipage'];
+        $more         = $elements['more'];
+        $numpages     = $elements['numpages'];
+
+        return true;
+    }
+
+    /**
+     * Generate post data.
+     *
+     * @since 5.2.0
+     *
+     * @param WP_Post|object|int $post WP_Post instance or Post ID/object.
+     * @return array|bool $elements Elements of post or false on failure.
+     */
+    public function generate_postdata( $post ) {
+
+        if ( ! ( $post instanceof WP_Post ) ) {
+            $post = get_post( $post );
+        }
+
+        if ( ! $post ) {
+            return false;
+        }
+
         $id = (int) $post->ID;
 
@@ -4236 +4272 @@
         do_action_ref_array( 'the_post', array( &$post, &$this ) );
 
-        return true;
+        $elements = compact( 'id', 'authordata', 'currentday', 'currentmonth', 'page', 'pages', 'multipage', 'more', 'numpages' );
+
+        return $elements;
     }
     /**