WP_Query::generate_postdata( WP_Post|object|int $post ): array|false

Compatibility

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

array|false

Elements of post or false on failure.

Performance profile

How much work a call to WP_Query::generate_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

Heavy

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

5–121

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 129.

Plugin surface

1 hook

Third-party callbacks on 'content_pagination' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• querycontent queryget_post()called directly
• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 18 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Query::generate_postdata() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while WP_Query::generate_postdata() runs, in this order:

1. 1
   apply_filters( content_pagination )filterline 4845 (+77 into the body)

   Filters the "pages" derived from splitting the post content.

Uses · 10

• get_post()Retrieves post data given a post ID or post object.
• get_userdata()Retrieves user info by user ID.
• get_queried_object_id()Retrieves the ID of the currently queried object.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_Query::get()Retrieves the value of a query variable.
• WP_Query::is_page()Determines whether the query is for an existing single page.
• WP_Query::is_single()Determines whether the query is for an existing single post.
• WP_Query::is_feed()Determines whether the query is for a feed.

Used by · 1

• WP_Query::setup_postdata()Sets up global post data.

Source code

View on Trac ↗View on GitHub ↗

4768	public function generate_postdata( $post ) {4769 4770		if ( ! ( $post instanceof WP_Post ) ) {4771			$post = get_post( $post );4772		}4773 4774		if ( ! $post ) {4775			return false;4776		}4777 4778		$id = (int) $post->ID;4779 4780		$authordata = get_userdata( $post->post_author );4781 4782		$currentday   = false;4783		$currentmonth = false;4784 4785		$post_date = $post->post_date;4786		if ( ! empty( $post_date ) && '0000-00-00 00:00:00' !== $post_date ) {4787			// Avoid using mysql2date for performance reasons.4788			$currentmonth = substr( $post_date, 5, 2 );4789			$day          = substr( $post_date, 8, 2 );4790			$year         = substr( $post_date, 2, 2 );4791 4792			$currentday = sprintf( '%s.%s.%s', $day, $currentmonth, $year );4793		}4794 4795		$numpages  = 1;4796		$multipage = 0;4797		$page      = $this->get( 'page' );4798		if ( ! $page ) {4799			$page = 1;4800		}4801 4802		/*4803		 * Force full post content when viewing the permalink for the $post,4804		 * or when on an RSS feed. Otherwise respect the 'more' tag.4805		 */4806		if ( get_queried_object_id() === $post->ID && ( $this->is_page() || $this->is_single() ) ) {4807			$more = 1;4808		} elseif ( $this->is_feed() ) {4809			$more = 1;4810		} else {4811			$more = 0;4812		}4813 4814		$content = $post->post_content;4815		if ( str_contains( $content, '<!--nextpage-->' ) ) {4816			$content = str_replace( "\n<!--nextpage-->\n", '<!--nextpage-->', $content );4817			$content = str_replace( "\n<!--nextpage-->", '<!--nextpage-->', $content );4818			$content = str_replace( "<!--nextpage-->\n", '<!--nextpage-->', $content );4819 4820			// Remove the nextpage block delimiters, to avoid invalid block structures in the split content.4821			$content = str_replace( '<!-- wp:nextpage -->', '', $content );4822			$content = str_replace( '<!-- /wp:nextpage -->', '', $content );4823 4824			// Ignore nextpage at the beginning of the content.4825			if ( str_starts_with( $content, '<!--nextpage-->' ) ) {4826				$content = substr( $content, 15 );4827			}4828 4829			$pages = explode( '<!--nextpage-->', $content );4830		} else {4831			$pages = array( $post->post_content );4832		}4833 4834		/**4835		 * Filters the "pages" derived from splitting the post content.4836		 *4837		 * "Pages" are determined by splitting the post content based on the presence4838		 * of `<!-- nextpage -->` tags.4839		 *4840		 * @since 4.4.04841		 *4842		 * @param string[] $pages Array of "pages" from the post content split by `<!-- nextpage -->` tags.4843		 * @param WP_Post  $post  Current post object.4844		 */4845		$pages = apply_filters( 'content_pagination', $pages, $post );4846 4847		$numpages = count( $pages );

Changelog

Introduced in 5.2.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/class-wp-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.