setup_postdata( WP_Post|object|int $post ): bool
Set up global post data.
Contents
Parameters
Return
bool True when finished.
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.
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 );
?>
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;
}
Changelog
Version | Description |
---|---|
4.4.0 | Added the ability to pass a post ID to $post . |
1.5.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
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.Example of using
setup_postdata
in a custom query:Here’s a good simple working example that also assigns the global $post before passing it to
setup_postdata
.Top ↑
Feedback
In general, you shouldn’t override the global
$post
, unless you know you need to. — By crstauf —Example 1
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: