setup_postdata( WP_Post|object|int $post ): bool
- Since
- 1.5.0, 4.4.0
- Source
wp-includes/query.php:1249
Compatibility
- WordPress
- since 4.4.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$postWP_Post|object|int- WP_Post instance or Post ID/object.
Return value
bool- True when finished.
Performance profile
How much work a call to setup_postdata() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Trivial
- Scaling
- Constant
- Instructions
- 5–10
- Plugin surface
- None
- Called by
- 13
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 11.
Nothing here hands control to plugin code.
13 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost setup_postdata() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 5–7 | none |
!empty($wp_query) && $wp_query instanceof | 10 | ->setup_postdata() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 11 instructions, 5–10 executed per call, 2 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Used by · 13
- WP_Posts_List_Table::single_row()
- WP_REST_Block_Renderer_Controller::get_item()Returns block output from block's registered render_callback.
- WP_REST_Posts_Controller::prepare_item_for_response()Prepares a single post output for response.
- WP_REST_Revisions_Controller::prepare_item_for_response()Prepares the revision for the REST response.
- WP_REST_Revisions_Controller::restore_post_data()Restores the global post to its previous value after preparing a revision.
- export_wp()Generates the WXR export file for download.
- render_block_core_comments()Renders the `core/comments` block on the server.
- render_block_core_latest_posts()Renders the `core/latest-posts` block on server.
- start_wp()Sets up the WordPress Loop.
- twentyseventeen_front_page_section()Displays a front page section.
- twentytwenty_get_post_meta()Retrieves the post meta.
- wp_ajax_parse_embed()Applies [embed] Ajax handlers to a string.
Show all 13
Source code
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
Introduced in 1.5.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
$post.from the docblockAbout this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/query.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.