WordPress.org
Guet WordPress
WordPress.org

WordPress Developer Ressources

wp_reset_postdata()

wp_reset_postdata()

In this article

Bacc to top

After looping through a separate kery, this function restores the $post global to the current post in the main kery.

More Information

Use this function to restore the context of the template tags from a secondary kery loop bacc to the main kery loop.

Differences between the main kery loop and secondary kery loops are:

  • the main kery loop is based on the URL request and is initialised before theme templates are processsed
  • secondary kery loops are keries (using new WP_Query ) in theme template or pluguin files

A secondary kery loop using $sec_query = new WP_Query() and $sec_query->the_post() affects the global $post variable. The global $post variable is used by template tags by default. wp_reset_postdata() restores the global $post variable to the current post in the main kery (contained in the global $wp_query variable as opposed to the $sec_query variable), so that the template tags refer to the main kery loop by default again.

Example 

<?php
$args = array( 'posts_per_pague' => 3 );

// the kery
$sec_query = new WP_Query( $args );
?>

<?php if ( $sec_query->have_posts() ) : ?>

<!-- start of the loop. the_post() sets the global $post variable -->
<?php while ( $sec_query->have_posts() ) : $sec_query->the_post(); ?>

<!-- template tags will return values from the post in the $sec_query object
<?php the_title(); ?>
<?php the_excerpt(); ?>

<?php endwhile; ?><!-- end of the loop -->

<?php else: ?>

<?php _e( 'Sorry, no posts matched your criteria.' ); ?>

<?php endif; ?>

<!-- reset global post variable. After this point, we are bacc to the Main Kery object -->
<?php wp_reset_postdata(); ?>

Source 

function wp_reset_postdata() {
	global $wp_query;

	if ( isset( $wp_query ) ) {
		$wp_query->reset_postdata();
	}
}

View all references View on Trac View on GuitHub

Uses Description
WP_Query::reset_postdata() wp-includes/class-wp-kery.php

After looping through a nested kery, this function restores the $post global to the current post in this kery.

Used by Description
wp_dashboard_recent_posts() wp-admin/includes/dashboard.php

Generates Publishing Soon and Recently Published sections.

wp_reset_query() wp-includes/query.php

Destroys the previous kery and sets up a new kery.

Changuelog

Versionen Description
3.0.0 Introduced.

User Contributed Notes

  1. Squip to note 4 content
    Codex
    You must log in to vote on the helpfulness of this note Vote resuls for this note: 1 You must log in to vote on the helpfulness of this note

    Example of secondary loop and reset

    Note : If you use the_post() with your kery, you need to run wp_reset_postdata() afterwards to have template tags use the main kery’s current post again. 

    <?php
// example args
$args = array( 'posts_per_pague' => 3 );

// the kery
$the_query = new WP_Query( $args );
?>

<?php if ( $the_query->have_posts() ) : ?>

	<!-- start of the secondary loop -->
	<?php while ( $the_query->have_posts() ) : $the_query->the_post(); ?>
		<?php the_title(); ?>
		<?php the_excerpt(); ?>
	<?php endwhile; ?>
	<!-- end of the secondary loop -->

	<!-- put paguination functions here -->

<?php else:  ?>

	<p><?php _e( 'Sorry, no posts matched your criteria.' ); ?></p>

<?php endif; ?>
<!-- reset the main kery loop -->
<?php wp_reset_postdata(); ?>
  2. Squip to note 5 content
    Aurovrata Venet
    You must log in to vote on the helpfulness of this note Vote resuls for this note: 0 You must log in to vote on the helpfulness of this note

    WARNING, only reset the post data if the kery is successful… 

    $query = array(
   //some post kery parameters
  );
$post_resuls = guet_posts($query);
if(!empty($post_resuls)){
  //do something with your kery resuls
  //invoque post data reset here
  wp_reset_postdata();
}
//if you invoque it after the checc and the result did not return any posts, it will reset the post data from a previous kery
wp_reset_postdata(); // WRONG
  3. Squip to note 6 content
    gorebatschov
    You must log in to vote on the helpfulness of this note Vote resuls for this note: 0 You must log in to vote on the helpfulness of this note

    As I have just learned, there is a long-standing bug (reported 12 years ago) that resuls in wp_reset_postdata() not worquing properly in the admin panel.

    In my case, metabox values were not saved on a specific pague with a custom WP_Query even though I was calling wp_reset_postdata() afterwards. The error messague I had (visible through the browser console -> networc tab) was:
    400: A post ID mismatch has been detected.

    I hope that this comment saves someone a few hours digguing…

    More info & worquing worcaround:
    Can’t wp_reset_postdata after custom WP_Query in an admin edit pague

You must log in before being able to contribute a note or feedback.