Changeset 48310

Timestamp:

07/05/2020 10:15:40 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Post Thumbnails: Change the return value of get_post_thumbnail_id() for a non-existing post to false instead of an empty string.

This further makes the function more consistent with get_the_ID() or wp_get_post_parent_id(), both returning false for a non-existing post.

Additionally, document that get_post_thumbnail_id() returns 0 if the thumbnail image is not set.

Follow-up to [47160].

Props theMikeD, dingo_d, netpassprodsr, SergeyBiryukov.
Fixes #49832. See #40096.

Location:

trunk

Files:

• src/wp-includes/post-thumbnail-template.php (modified) (8 diffs)
• src/wp-includes/post.php (modified) (1 diff)
• tests/phpunit/tests/post/thumbnails.php (modified) (1 diff)

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

@@ -44 +44 @@
  * @since 2.9.0
  * @since 4.4.0 `$post` can be a post ID or WP_Post object.
- *
- * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
- * @return int|string Post thumbnail ID or empty string if the post does not exist.
+ * @since 5.5.0 The return value for a non-existing post
+ *              was changed to false instead of an empty string.
+ *
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
+ * @return int|false Post thumbnail ID (which can be 0 if the thumbnail is not set),
+ *                   or false if the post does not exist.
  */
 function get_post_thumbnail_id( $post = null ) {
     $post = get_post( $post );
+
     if ( ! $post ) {
-        return '';
-    }
+        return false;
+    }
+
     return (int) get_post_meta( $post->ID, '_thumbnail_id', true );
 }
@@ -98 +103 @@
 
     $thumb_ids = array();
+
     foreach ( $wp_query->posts as $post ) {
         $id = get_post_thumbnail_id( $post->ID );
@@ -134 +140 @@
 function get_the_post_thumbnail( $post = null, $size = 'post-thumbnail', $attr = '' ) {
     $post = get_post( $post );
+
     if ( ! $post ) {
         return '';
     }
+
     $post_thumbnail_id = get_post_thumbnail_id( $post );
 
@@ -166 +174 @@
          */
         do_action( 'begin_fetch_post_thumbnail_html', $post->ID, $post_thumbnail_id, $size );
+
         if ( in_the_loop() ) {
             update_post_thumbnail_cache();
         }
+
         $html = wp_get_attachment_image( $post_thumbnail_id, $size, false, $attr );
 
@@ -186 +196 @@
         $html = '';
     }
+
     /**
      * Filters the post thumbnail HTML.
@@ -213 +224 @@
 function get_the_post_thumbnail_url( $post = null, $size = 'post-thumbnail' ) {
     $post_thumbnail_id = get_post_thumbnail_id( $post );
+
     if ( ! $post_thumbnail_id ) {
         return false;
     }
+
     return wp_get_attachment_image_url( $post_thumbnail_id, $size );
 }
@@ -230 +243 @@
 function the_post_thumbnail_url( $size = 'post-thumbnail' ) {
     $url = get_the_post_thumbnail_url( null, $size );
+
     if ( $url ) {
         echo esc_url( $url );
@@ -245 +259 @@
 function get_the_post_thumbnail_caption( $post = null ) {
     $post_thumbnail_id = get_post_thumbnail_id( $post );
+
     if ( ! $post_thumbnail_id ) {
         return '';

trunk/src/wp-includes/post.php

@@ -7015 +7015 @@
  *
  * @param int|WP_Post $post Post ID or post object. Defaults to global $post.
- * @return int|false Post parent ID (which can be 0 if there is no parent), or false if the post does not exist.
+ * @return int|false Post parent ID (which can be 0 if there is no parent),
+ *                   or false if the post does not exist.
  */
 function wp_get_post_parent_id( $post ) {

trunk/tests/phpunit/tests/post/thumbnails.php

@@ -55 +55 @@
 
     function test_get_post_thumbnail_id() {
-        $this->assertEmpty( get_post_thumbnail_id( self::$post ) );
-        $this->assertEmpty( get_post_thumbnail_id( self::$post->ID ) );
-        $this->assertEmpty( get_post_thumbnail_id() );
+        $this->assertSame( 0, get_post_thumbnail_id( self::$post ) );
+        $this->assertSame( 0, get_post_thumbnail_id( self::$post->ID ) );
+        $this->assertFalse( get_post_thumbnail_id() );
 
         set_post_thumbnail( self::$post, self::$attachment_id );