setup_postdata( WP_Post|object|int $post ): bool

User Contributed Notes

1. Skip to note 7 content

   mslade 10 years ago

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

   An important note about setup_postdata and the $post global: setup_postdata( $new_post ) sets various globals related to the current post but it does not update the $post global. This disjoint can cause problems both in WP internals and in plugins/themes.

   Therefore if you call setup_postdata( $new_post ), you should also assign it to the global $post object.
2. Skip to note 8 content

   Aurovrata Venet 4 years ago

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

   <ul>
       <?php
       global $post;
        
       $myposts = get_posts( array(
           'posts_per_page' => 5,
           'offset'         => 1,
           'category'       => 1
       ) );
        
       if ( $myposts ) :
           foreach ( $myposts as $post ) :
             setup_postdata( $post ); ?>
               <li><a href="<?php the_permalink(); ?>"><?php the_title(); ?></a></li>
           endforeach; 
           wp_reset_postdata();
       endif;
       ?>
   </ul>
3. Skip to note 9 content

   Ahmad Karim 3 years ago

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

   Example of using setup_postdata in a custom query:

   global $wpdb, $post;
   
   $query = "SELECT * FROM `wp_posts` WHERE `post_type` = 'cpt_1' AND `post_status` = 'publish' AND `comment_count` > 0 LIMIT 5";
   $result = $wpdb->get_results($query, OBJECT);
   
   if ( $result && count($result) > 0 ):
   
     echo '<ol>';
   
     foreach ($result as $post):
   
       setup_postdata($post);
   
       echo '<li>';
   
       the_title();
   
       echo '</li>';
   
     endforeach;
   
     echo '</ol>';
   
     wp_reset_postdata();
   
   endif;
4. Skip to note 10 content

   stratboy 3 years ago

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

   Here’s a good simple working example that also assigns the global $post before passing it to setup_postdata.

   // ... your custom query..., and then:
   
   global $post; // Call global $post variable
   
   foreach ( $your_posts as $current_post ) {
   	$post = $current_post; // Set $post global variable to the current post object   
   	setup_postdata( $post ); // Set up "environment" for template tags
   
   	// Use template tags normally
   	the_title();
   	the_post_thumbnail( 'large' );
   	the_excerpt();
   	// Or the_content(), the_permalink(), etc.
   }
   
   wp_reset_postdata();

   • In general, you shouldn’t override the global $post, unless you know you need to.

     crstauf 3 years ago
5. Skip to note 11 content

   Codex 9 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

   Example 1

   <ul>
   	<?php
   	global $post;
   	
   	$myposts = get_posts( array(
   		'posts_per_page' => 5,
   		'offset'         => 1,
   		'category'       => 1
   	) );
   	
   	if ( $myposts ) :
   		foreach ( $myposts as $mypost ) :
   		  setup_postdata( $mypost ); ?>
   			<li><a href="<?php the_permalink(); ?>"><?php the_title(); ?></a></li>
   		endforeach; 
   		wp_reset_postdata();
   	endif;
   	?>
   </ul>
6. Skip to note 12 content

   Zane Matthew 5 years ago

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

   Note, it is probably best not to use this function, although it is neat, it goes against WordPress’ own coding standards.

   Issue reported here, back in 2017.

   If you use this function, and run PHPCS with WordPress standards you’ll see this error:

    24 | ERROR | [ ] Overriding WordPress globals is prohibited. Found assignment to $post