Changeset 44941 for trunk/src/wp-includes/formatting.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/formatting.php (modified) (1 diff)

trunk/src/wp-includes/formatting.php

@@ -3679 +3679 @@
  *
  * @since 1.5.0
- *
- * @param string $text Optional. The excerpt. If set to empty, an excerpt is generated.
+ * @since 5.2.0 Added the `$post` parameter.
+ *
+ * @param string             $text Optional. The excerpt. If set to empty, an excerpt is generated.
+ * @param WP_Post|object|int $post Optional. WP_Post instance or Post ID/object. Default is null.
  * @return string The excerpt.
  */
-function wp_trim_excerpt( $text = '' ) {
+function wp_trim_excerpt( $text = '', $post = null ) {
     $raw_excerpt = $text;
     if ( '' == $text ) {
-        $text = get_the_content( '' );
+        $post = get_post( $post );
+        $text = get_the_content( '', false, $post );
 
         $text = strip_shortcodes( $text );