setup_postdata( WP_Post|object|int $post )

Set up global post data.

Contents

Description Description

Parameters Parameters

$post

(WP_Post|object|int) (Required) WP_Post instance or Post ID/object.

Top ↑

Return Return

(bool) True when finished.

Top ↑

Source Source

File: wp-includes/query.php

1105
1106
1107
1108
1109
1110
1111
1112
1113
function setup_postdata( $post ) {
    global $wp_query;
 
    if ( ! empty( $wp_query ) && $wp_query instanceof WP_Query ) {
        return $wp_query->setup_postdata( $post );
    }
 
    return false;
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

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

Top ↑

Top ↑

Used By Used By

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

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

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

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

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

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

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

Top ↑

User Contributed Notes 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: 5You 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: -1You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Example 2

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    <ul>
    <?php
    global $wpdb, $post;
     
    $str    = "SELECT $wpdb->posts.* FROM $wpdb->posts WHERE post_type = 'post' AND post_status = 'publish'";
    $result = $wpdb->get_results( $str );
     
    if ( $result ) {
        foreach ( $result as $post ):
            setup_postdata( $post );
            ?>
            <li><a href="<?php the_permalink()?>"><?php the_title();?></a></li>
            <?php
        endforeach;
    }
    ?>
    </ul>

    Expand full source codeCollapse full source code

  3. Skip to note 3 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

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    <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>

    Expand full source codeCollapse full source code

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