函数文档

generate_postdata()

💡 云策文档标注

概述

generate_postdata() 是一个 WordPress 函数,用于生成文章数据。它通常与 WP_Query 实例关联,通过调用 WP_Query::generate_postdata() 方法来处理文章数据。

关键要点

  • 参数:接受一个必需的参数 $post,可以是 WP_Post 实例、文章对象或文章 ID。
  • 返回值:成功时返回文章数据数组,失败时返回 false。
  • 依赖关系:函数内部检查全局 $wp_query 是否为 WP_Query 实例,如果是则调用其 generate_postdata() 方法。
  • 引入版本:自 WordPress 5.2.0 起引入。

代码示例

function generate_postdata( $post ) {
	global $wp_query;

	if ( ! empty( $wp_query ) && $wp_query instanceof WP_Query ) {
		return $wp_query->generate_postdata( $post );
	}

	return false;
}

注意事项

  • 此函数依赖于全局 $wp_query 变量,确保在调用前 $wp_query 已正确初始化为 WP_Query 实例,否则可能返回 false。
  • 相关函数:get_the_content() 使用此函数来检索文章内容。

📄 原文内容

Generates post data.

Parameters

$postWP_Post|object|intrequired
WP_Post instance or Post ID/object.

Return

array|false Elements of post, or false on failure.

Source

function generate_postdata( $post ) {
	global $wp_query;

	if ( ! empty( $wp_query ) && $wp_query instanceof WP_Query ) {
		return $wp_query->generate_postdata( $post );
	}

	return false;
}

Changelog

Version Description
5.2.0 Introduced.