get_the_post_thumbnail_url( int|WP_Post|null $post = null, string|int[] $size = 'post-thumbnail' ): string|false

User Contributed Notes

1. Skip to note 5 content

   codeunderground 8 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 17You must log in to vote on the helpfulness of this note

   Don’t ignore the first parameter.
   Proper usage of `get_the_post_thumbnail_url() ` inside the loop:

   if ( have_posts() ) {
       while ( have_posts() ) {
           the_post();
     
           /* grab the url for the full size featured image */
           $featured_img_url = get_the_post_thumbnail_url(get_the_ID(),'full'); 
    
           /* link thumbnail to full size image for use with lightbox*/
           echo '<a href="'.esc_url($featured_img_url).'" rel="lightbox">'; 
               the_post_thumbnail('thumbnail');
           echo '</a>';
       endwhile; 
   endif; 
2. Skip to note 6 content

   Raul P. 7 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note

   It’s worth to note that, if you upload a smaller image (let’s say, a 600px wide) and use this to fetch a specific larger image (let’s say, a 1920px wide for your cover), it will return the original image instead (which is smaller than what you need) instead of returning false.

   If you need to fallback to another image in case the specified file doesn’t exist, you can look into wp_get_attachment_image_src instead, and check for the width or height of the image.
3. Skip to note 7 content

   LindsayMac 8 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note

   Downvoted the example posted from @thelilmercoder as it is not proper usage of this function.

   Proper usage of `get_the_post_thumbnail_url()` inside the loop:

   if ( have_posts() ) {
   	while ( have_posts() ) {
   		the_post();
    
   		/* grab the url for the full size featured image */ 
   		$featured_img_url = get_the_post_thumbnail_url('full'); 
   
   		/* link thumbnail to full size image for use with lightbox*/ 
   		echo '<a href="'.$featured_img_url.'" rel="lightbox">'; 
   			the_post_thumbnail('thumbnail');
   		echo '</a>';
   	endwhile; 
   endif; 

   Proper usage of `get_the_post_thumbnail_url()` outside the loop:

   /* get a specific post object by ID */ 
   $post = get_post(2);
    
   /* grab the url for the full size featured image */ 
   $featured_img_url = get_the_post_thumbnail_url($post->ID, 'full'); 
   
   /* link thumbnail to full size image for use with lightbox*/ 
   echo '<a href="'.$featured_img_url.'" rel="lightbox">'; 
   	the_post_thumbnail('thumbnail');
   echo '</a>';

   • There seems to be a mistake in Proper usage of get_the_post_thumbnail_url() inside the loop:. The first argument of get_the_post_thumbnail_url() should be the post ID or object, not the image size. You might want to add get_the_ID() before ‘full’ argument to get the full-size featured image URL.

     Muhammad Ahmad 2 years ago
4. Skip to note 8 content

   Rose 9 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: -14You must log in to vote on the helpfulness of this note

   To display the featured image with the alt tag use something like this

   $thumbnail = get_the_post_thumbnail_url();
   
   if ( $thumbnail ) {
   	$alt_text = get_post_meta( $thumbnail->ID, '_wp_attachment_image_alt', true );
   
       if ( ! empty( $thumbnail ) ) {
   		if ( ! empty( $alt_text ) ) {
   			$alt_text = $alt_text;
          } else {
   			$alt_text = __( 'no alt text set', 'textdomain' ); 
          }
   	   echo '';
      }
   }

   • get_the_post_thumbnail_url() function return a thumbnail URL as string or false on error. So, you can’t access media ID through $thumbnail->ID. This code has error.

     WP Offers 5 years ago
   • The $thumbnail will return the URL (string), not the image object. This won’t work. You could try to use attachment_url_to_postid( $thumbnail ) to try and get the attachment ID.

     Denis Žoljom 4 years ago