Changeset 44941 for trunk/src/wp-includes/post-template.php

Timestamp:

03/20/2019 03:48:46 PM (7 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/post-template.php (modified) (8 diffs)

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

@@ -254 +254 @@
  *
  * @since 0.71
+ * @since 5.2.0 Added the `$post` parameter.
  *
  * @global int   $page      Page number of a single post/page.
@@ -262 +263 @@
  * @global int   $multipage Boolean indicator for whether multiple pages are in play.
  *
- * @param string $more_link_text Optional. Content for when there is more text.
- * @param bool   $strip_teaser   Optional. Strip teaser content before the more text. Default is false.
+ * @param string             $more_link_text Optional. Content for when there is more text.
+ * @param bool               $strip_teaser   Optional. Strip teaser content before the more text. Default is false.
+ * @param WP_Post|object|int $post           Optional. WP_Post instance or Post ID/object. Default is null.
  * @return string
  */
-function get_the_content( $more_link_text = null, $strip_teaser = false ) {
+function get_the_content( $more_link_text = null, $strip_teaser = false, $post = null ) {
     global $page, $more, $preview, $pages, $multipage;
 
-    $post = get_post();
+    $_post = get_post( $post );
+
+    if ( ! ( $_post instanceof WP_Post ) ) {
+        return '';
+    }
+
+    if ( null === $post ) {
+        $elements = compact( 'page', 'more', 'preview', 'pages', 'multipage' );
+    } else {
+        $elements = generate_postdata( $_post );
+    }
 
     if ( null === $more_link_text ) {
@@ -277 +289 @@
                 /* translators: %s: Name of current post */
                 __( 'Continue reading %s' ),
-                the_title_attribute( array( 'echo' => false ) )
+                the_title_attribute(
+                    array(
+                        'echo' => false,
+                        'post' => $_post,
+                    )
+                )
             ),
             __( '(more…)' )
@@ -287 +304 @@
 
     // If post password required and it doesn't match the cookie.
-    if ( post_password_required( $post ) ) {
-        return get_the_password_form( $post );
-    }
-
-    if ( $page > count( $pages ) ) { // if the requested page doesn't exist
-        $page = count( $pages ); // give them the highest numbered page that DOES exist
-    }
-
-    $content = $pages[ $page - 1 ];
+    if ( post_password_required( $_post ) ) {
+        return get_the_password_form( $_post );
+    }
+
+    if ( $elements['page'] > count( $elements['pages'] ) ) { // if the requested page doesn't exist
+        $elements['page'] = count( $elements['pages'] ); // give them the highest numbered page that DOES exist
+    }
+
+    $page_no = $elements['page'];
+    $content = $elements['pages'][ $page_no - 1 ];
     if ( preg_match( '/<!--more(.*?)?-->/', $content, $matches ) ) {
         $content = explode( $matches[0], $content, 2 );
@@ -307 +325 @@
     }
 
-    if ( false !== strpos( $post->post_content, '<!--noteaser-->' ) && ( ! $multipage || $page == 1 ) ) {
+    if ( false !== strpos( $_post->post_content, '<!--noteaser-->' ) && ( ! $elements['multipage'] || $elements['page'] == 1 ) ) {
         $strip_teaser = true;
     }
@@ -313 +331 @@
     $teaser = $content[0];
 
-    if ( $more && $strip_teaser && $has_teaser ) {
+    if ( $elements['more'] && $strip_teaser && $has_teaser ) {
         $teaser = '';
     }
@@ -320 +338 @@
 
     if ( count( $content ) > 1 ) {
-        if ( $more ) {
-            $output .= '<span id="more-' . $post->ID . '"></span>' . $content[1];
+        if ( $elements['more'] ) {
+            $output .= '<span id="more-' . $_post->ID . '"></span>' . $content[1];
         } else {
             if ( ! empty( $more_link_text ) ) {
@@ -333 +351 @@
                  * @param string $more_link_text    Read More text.
                  */
-                $output .= apply_filters( 'the_content_more_link', ' <a href="' . get_permalink() . "#more-{$post->ID}\" class=\"more-link\">$more_link_text</a>", $more_link_text );
+                $output .= apply_filters( 'the_content_more_link', ' <a href="' . get_permalink( $_post ) . "#more-{$_post->ID}\" class=\"more-link\">$more_link_text</a>", $more_link_text );
             }
             $output = force_balance_tags( $output );