WordPress.org

Function Reference/setup postdata

Description

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

Usage

<?php global $post; setup_postdata( $post ); ?>

Parameters

$post

(object) (required) A post object.

Default: None

Important: You must make use the global $post variable to pass the post details into this function, otherwise functions like the_title() don't work properly...

Example...

   global $post;
   
   // Assign your post details to $post (& not any other variable name!!!!)
   $post = $post_object;
   
   setup_postdata( $post );
   ...

This will not work...

   global $post;
   
   setup_postdata( $post_object );

Return Values

This function always returns true.

Example 1

<ul>
<?php
global $post;
$args = array( 'numberposts' => 5, 'offset'=> 1, 'category' => 1 );
$myposts = get_posts( $args );
foreach( $myposts as $post ) :	setup_postdata($post); ?>
	<li><a href="<?php the_permalink(); ?>"><?php the_title(); ?></a></li>
<?php endforeach; wp_reset_postdata(); ?>
</ul>

Example 2

<ul>
<?php
global $wpdb;
global $post;
$str = "SELECT $wpdb->posts.* FROM $wpdb->posts WHERE post_type = 'post' AND post_status = 'publish'";
$result = $wpdb->get_results($str);
foreach($result as $post):setup_postdata($post);?>
	<li><a href="<?php the_permalink()?>"><?php the_title();?></a></li><?php 
endforeach;?>
</ul>

Change Log

Since: 1.5.0

Source File

setup_postdata() is located in wp-includes/query.php.

Class: WP_Query - Detailed overview of the WP_Query class
Class: $wpdb - Overview of using the $wpdb object
Function: get_query_var()
Function: query_posts() - Make additional custom queries
Function: get_posts() - A specialized function that returns an array of posts
Function: get_pages() - A specialized function that returns an array of pages
Function: have posts() - A conditional that determines if the query returned any posts
Function: the_post() - Used to automatically set up the loop after a query
Function: rewind_posts() - Resets the current loop
Function: setup_postdata() - Setup query data for individual results within a loop
Function: wp_reset_postdata() - Restores the previous query (usually after a loop-within-a-loop)
Function: wp_reset_query()
Function: is_main_query() - Ensures the query being changed is only the main query
Action Hook: pre_get_posts - Modify WordPress queries before they are executed
Filter Hook: found_posts - Modify the WP_Query object's found_posts value
Tutorial: Displaying Posts Using a Custom Select Query
Tutorial: Making Advanced Taxonomy Queries
Tutorial: Making Custom Queries using Offset and Pagination

See also index of Function Reference and index of Template Tags.

WordPress.org

Codex

Function Reference/setup postdata

Contents