Why is it necessary to call rewind_posts() when using the loop more than once? [duplicate]

Global rewind_posts

File: wp-includes/query.php
784: /**
785:  * Rewind the loop posts.
786:  *
787:  * @since 1.5.0
788:  *
789:  * @global WP_Query $wp_query Global WP_Query instance.
790:  */
791: function rewind_posts() {
792:    global $wp_query;
793:    $wp_query->rewind_posts();
794: }

and rewind_posts from WP_Query class.

File: wp-includes/class-wp-query.php
3144:    * Rewind the posts and reset post index.
3145:    *
3146:    * @since 1.5.0
3147:    * @access public
3148:    */
3149:   public function rewind_posts() {
3150:       $this->current_post = -1;
3151:       if ( $this->post_count > 0 ) {
3152:           $this->post = $this->posts[0];
3153:       }
3154:   }

can help us understand we are actually in the context of $wp_query object when we are rewinding using the global rewind_posts.

The codex pointer you set:

// main loop
<?php if (have_posts()) : while (have_posts()) : the_post(); ?>
<?php the_content(); ?>
<?php endwhile; endif; ?>

// rewind
<?php rewind_posts(); ?>

// new loop
<?php while (have_posts()) : the_post(); ?>
<?php the_content(); ?>
<?php endwhile; ?>

suggests that this has to do something with the $the_post method.

So, what is the nature of the_post()?

File: /class-wp-query.php
3095:   public function the_post() {
3096:       global $post;
3097:       $this->in_the_loop = true;
3098: 
3099:       if ( $this->current_post == -1 ) // loop has just started
3100:           /**
3101:            * Fires once the loop is started.
3102:            *
3103:            * @since 2.0.0
3104:            *
3105:            * @param WP_Query &$this The WP_Query instance (passed by reference).
3106:            */
3107:           do_action_ref_array( 'loop_start', array( &$this ) );
3108: 
3109:       $post = $this->next_post();
3110:       $this->setup_postdata( $post );
3111:   }

enter image description here

At least we can understand that there is a global $post object being set each time we iterate the while loop.

The key for understanding is the next_post() method.

File: wp-includes/class-wp-query.php
3068:   /**
3069:    * Set up the next post and iterate current post index.
3070:    *
3071:    * @since 1.5.0
3072:    * @access public
3073:    *
3074:    * @return WP_Post Next post.
3075:    */
3076:   public function next_post() {
3077: 
3078:       $this->current_post++;
3079: 
3080:       $this->post = $this->posts[$this->current_post];
3081:       return $this->post;
3082:   }

That method finally explains we increment the current post pointer:

$this->current_post++;

Note that in the expression above the whole variable $this->current_post will be incremented.

($this->current_post)++;

This is equivalent to:

$this->current_post = $this->current_post + 1;

for those that hate to admit the syntax $this->current_post++; is pretty cool to increment a variable.

To recap:

Since we called the_post() and increased the $this->current_post pointer we need now to set this pointer to -1, if we plan to loop again.

3149:   public function rewind_posts() {
3150:       $this->current_post = -1;
3151:       if ( $this->post_count > 0 ) {
3152:           $this->post = $this->posts[0];
3153:       }
3154:   }

Strange enought, but it works.

Related Posts:

  1. Is `query_posts` really slower than secondary query?
  2. Are there any scenarios where the query_posts may be used?
  3. Multiple posts with one loop iteration
  4. Post Loop not Returning Permalink
  5. How to Loop within a Loop (Display Children and then Grandchildren)
  6. Exclude first 2 posts with meta_key from loop
  7. Better way to display posts from specific categories, in a grid layout
  8. popular post weekly and monthly
  9. 3 Posts in Loop, Show Stickies First
  10. Query last updated posts (posts updated in the last 24 hours)
  11. Displaying terms based on loop posts?
  12. Duplicated posts on category page
  13. Make blog page show 10 on first page, 9 on every other page
  14. How to display posts by vote count and if no value continue with latest posts with no votes?
  15. query_posts() vs get_posts() multiple loops [duplicate]
  16. Exclude first post (sticky or not) from the loop using query_posts()
  17. How to order by multiple fields using standard query_posts?
  18. Pagination not working in category listing [duplicate]
  19. How can I improve the performance of this query_posts loop?
  20. Adding div after every two post on main loop! Why will first post not get counted?
  21. How can I access specific posts brought back by query_posts?
  22. Separate First Post Loop
  23. Query posts only with actual text content (not including shortcode or images)
  24. query_posts clarification needed
  25. Exclude current post ID from loop in sidepbar.php
  26. Why does my WP_Query pagination on a custom page.php only loads the homepage?
  27. Get a Post Loop based on Logged in User information into a Shortcode
  28. how to add 4 post in one carousel slide
  29. Query counting excluded category on paged loop
  30. get_posts and wp_autop (remove filter)
  31. query_posts ignores the argument
  32. The Loop isn’t working
  33. Twitter bootstrap carousel multiple items in carousel
  34. show posts from one category with comments only
  35. Least Number of Loops to Create Custom Homepage?
  36. How to do query_posts on tags pages
  37. Limitless amount of posts in custom archive page
  38. How do I get the attributes of a short code from a post?
  39. wordpress loop for specific category
  40. Three different post types on homepage
  41. Add Incrementing ID to each paragraph in the_content
  42. Transient not working for custom loops
  43. Custom Loop, Match Category with Page
  44. Display page of custom posts?
  45. include(locate_template) messing up the loop
  46. WordPress – thumbnail image from youtube (function and loop)
  47. Loop – how to get previous/next post for first/last post?
  48. Loop through all media library images and return those where caption contains the text carousel
  49. 2 loops on page – one with orderby rand second orderby date
  50. Displaying the last page of posts
  51. show a post from a specific post format
  52. How to return only one instance of each, from the entire loop
  53. Combining action and filter?
  54. Shortcode with a foreach and arguments
  55. How to exclude latest x posts from a paginated query?
  56. Calling & display certain product category loop and pagination on the homepage
  57. Detect if current page is front page within custom query
  58. Sanitize Custom Field Value in Meta Query
  59. Default ‘post’ post type archive slug?
  60. show random image in loop if image is not set
  61. Listing all term items alphabetically / sorting loop
  62. need help looping add_action in wp
  63. Does WordPress Loop have a function like Shopify’s cycle?
  64. Combine the results of two loops [closed]
  65. Add leading zero to current post display [closed]
  66. Output meta into arrays
  67. Pagination on category.php and tag.php not working
  68. Moving wordpress to different url/server creates redirect loop
  69. Pulling in featured image into default recent posts widget
  70. WP_Query: Show 10 posts in date order, first three random
  71. Modify loop output for a specific list of categories
  72. Print the whole page?
  73. Pagination for two loops
  74. Loop info in jquery Tabs – loop into a variable?
  75. Custom Post Type Query W/Category Dropdown
  76. Thumbnail Image Rounded Corners w CSS (or any other good method)
  77. Several loops in sidebar issues
  78. Create a Loop with Posts Ordered by Most Recent Comments
  79. Adding $args to wp_schedule_event() causes hook to add infinitely to WP Cron
  80. $post is undefined in wordpress loop [ajax]
  81. Insert content above an embedded video inside Wordress’ php the_content
  82. the loop printing post in one grid
  83. Check value of post meta within IF statement
  84. My WordPress installation doesn’t load correct template
  85. Work arounds for conditional checks inside the loop in search.php?
  86. query_posts() doesn’t seem to be called in my page
  87. Get Sticky User in user loop based on user role
  88. Popular posts with Varnish ESI
  89. Querying posts from only one category and exluding the latest post
  90. WP update_post_meta link loop
  91. Need some help with “the_widget()” function
  92. Conditional Check in The Loop’s Parameters
  93. Exclude Authors based off date of last post
  94. WordPress loop problem: Multiple loops, index.php and is_paged causing duplicate posts on next page
  95. Loop from another WP site onto mine
  96. Having issue with WordPress loop
  97. How to add class to the last image of the last post in a loop
  98. How to exclude certain portfolios from a loop
  99. Divide loop into several columns based on post custom field and enable infinite scrolling
  100. Query Loop Block: possible to restrict just child pages?

Leave a Comment