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

Set up global post data.

Contents

Parameters

$post WP_Post|object|int Required
WP_Post instance or Post ID/object.

Top ↑

Return

bool True when finished.

Top ↑

More Information

Sets up global post data. Helps to format custom query results for using Template tags.

setup_postdata() fills the global variables $id, $authordata, $currentday, $currentmonth, $page, $pages, $multipage, $more, $numpages, which help many Template Tags work in the current post context.

setup_postdata() does not assign the global $post variable so it’s important that you do this yourself. Failure to do so will cause problems with any hooks that use any of the above globals in conjunction with the $post global, as they will refer to separate entities.

Top ↑

Usage

<?php
global $post;

// modify the $post variable with the post data you want. Note that this variable must have this name!

setup_postdata( $post );
?>

 

 

Top ↑

Source

File: wp-includes/query.php. View all references 

function setup_postdata( $post ) {
	global $wp_query;

	if ( ! empty( $wp_query ) && $wp_query instanceof WP_Query ) {
		return $wp_query->setup_postdata( $post );
	}

	return false;
}

View on Trac View on GitHub

Top ↑

Top ↑

Used By

Used By
Used By Description
WP_REST_Block_Renderer_Controller::get_item() wp-includes/rest-api/endpoints/class-wp-rest-block-renderer-controller.php

Returns block output from block’s registered render_callback.
WP_REST_Revisions_Controller::prepare_item_for_response() wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php

Prepares the revision for the REST response.
WP_REST_Posts_Controller::prepare_item_for_response() wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

Prepares a single post output for response.
wp_ajax_parse_embed() wp-admin/includes/ajax-actions.php

Apply [embed] Ajax handlers to a string.
wp_ajax_parse_media_shortcode() wp-admin/includes/ajax-actions.php
export_wp() wp-admin/includes/export.php

Generates the WXR export file for download.
WP_Posts_List_Table::single_row() wp-admin/includes/class-wp-posts-list-table.php
start_wp() wp-includes/deprecated.php

Sets up the WordPress Loop.
Show 3 more used by Hide more used by

Top ↑

Changelog

Changelog
Version Description
4.4.0 Added the ability to pass a post ID to $post.
1.5.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 12You must log in to vote on the helpfulness of this note
    Contributed by mslade —

    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 2 content
    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
    Contributed by Ahmad Karim —

    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;
  3. Skip to note 3 content
    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
    Contributed by Aurovrata Venet — 
    <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>
  4. Skip to note 4 content
    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
    Contributed by stratboy —

    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();
  5. Skip to note 5 content
    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
    Contributed by Codex —

    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 6 content
    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
    Contributed by Zane Matthew —

    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

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