WordPress at a glance
function is not described

WP_Query::the_post() WP 1.5.0

Sets up the current post.

Retrieves the next post, sets up the post, sets the 'in the loop' property to true.

This is a method of the class: WP_Query

Hooks from the method
Return

Null. Nothing.

Usage

$WP_Query = new WP_Query();
$var = $WP_Query->the_post();

Notes

  • Global. WP_Post. $post

Changelog

Since 1.5.0 Introduced.

Code of WP Query::the post: wp-includes/class-wp-query.php WP 5.2.3

<?php
public function the_post() {
	global $post;
	$this->in_the_loop = true;

	if ( $this->current_post == -1 ) { // loop has just started
		/**
		 * Fires once the loop is started.
		 *
		 * @since 2.0.0
		 *
		 * @param WP_Query $this The WP_Query instance (passed by reference).
		 */
		do_action_ref_array( 'loop_start', array( &$this ) );
	}

	$post = $this->next_post();
	$this->setup_postdata( $post );
}