解析 WordPress `WP_Post` 类源码：从数据库行实例化文章对象的流程。

各位观众老爷，晚上好！我是你们的老朋友，今天咱们来聊聊WordPress里那个神秘又重要的家伙——WP_Post类。别看它名字普普通通，它可是WordPress里文章、页面、自定义文章类型等等内容的核心骨架。今天，我们就来扒一扒它的皮，看看它是如何从数据库里一行行冷冰冰的数据，摇身一变，成为一个活生生的文章对象的。

开场白：WP_Post是谁？我们为什么要关心它？

简单来说，WP_Post就是一个PHP类，它代表了WordPress里的一篇文章（或者页面，或者任何自定义文章类型）。当我们要在主题里显示文章标题、内容、作者等等信息时，我们操作的对象就是WP_Post类的实例。

为什么我们要关心它？因为它无处不在！你几乎在任何涉及到文章显示的地方都会看到它的身影。理解了WP_Post的实例化过程，就能更深入地理解WordPress的内部机制，也能更好地定制和扩展WordPress的功能。

正文：从数据库行到WP_Post对象，一次神奇的变形记

好，废话不多说，咱们直接进入主题。WP_Post的实例化过程，说白了，就是把数据库里的一行数据（对应一篇文章）转换成一个PHP对象的过程。这个过程的核心在于WP_Post类的构造函数和一些相关的函数。

1. 数据库查询：信息的源头

首先，我们要从数据库里获取文章数据。这通常是由WordPress的各种查询函数来完成的，比如get_posts()、WP_Query等等。这些函数最终会执行SQL查询，从wp_posts表（以及可能的其他相关表）中取出数据。

// 举个栗子，用get_posts()获取文章
$posts = get_posts( array(
    'numberposts' => 5, // 获取最近的5篇文章
    'orderby'     => 'post_date',
    'order'       => 'DESC',
) );

// $posts 现在是一个WP_Post对象数组
if ( $posts ) {
    foreach ( $posts as $post ) {
        // 这里的 $post 就是一个 WP_Post 对象
        setup_postdata( $post ); // 重要的！设置全局的 $post 变量
        echo '<h2>' . get_the_title() . '</h2>';
        echo '<p>' . get_the_excerpt() . '</p>';
    }
    wp_reset_postdata(); // 重置全局的 $post 变量
}

在这个例子中，get_posts()函数返回的是一个WP_Post对象数组。每个WP_Post对象都包含了从数据库中获取的文章信息。

2. WP_Post类的构造函数：初次相遇

当我们从数据库获取到文章数据后，WordPress会调用WP_Post类的构造函数来创建一个新的WP_Post对象。WP_Post的构造函数非常简单：

/**
 * WP_Post::__construct()
 *
 * @param WP_Post|object|int|null $post Post object or ID. Default null.
 */
public function __construct( $post = null ) {
    if ( is_numeric( $post ) ) {
        $post = get_post( $post );
    } elseif ( $post instanceof WP_Post ) {
        $post = clone $post;
    } elseif ( isset( $post->filter ) && 'raw' == $post->filter ) {
        $post = clone $post;
    } else {
        $post = get_post( $post );
    }

    foreach ( get_post_class( '', $post->ID ) as $key => $value ) {
         $post->classes[] = $value;
    }

    foreach ( get_object_vars( $post ) as $key => $value ) {
        $this->$key = $value;
    }
}

这个构造函数接收一个参数$post，它可以是：

• 一个WP_Post对象（或者对象ID）：这种情况下，构造函数会克隆这个对象。
• 一个包含文章属性的对象（通常是数据库查询返回的结果）：构造函数会将这些属性复制到新的WP_Post对象中。
• 一个文章ID（整数）：构造函数会使用get_post()函数来获取文章对象。
• null：创建一个空的WP_Post对象。

构造函数的核心逻辑是：

1. 参数处理： 根据$post的类型，选择合适的处理方式（克隆、获取、创建）。
2. 属性复制： 将$post对象的所有属性复制到新的WP_Post对象中。这里使用了get_object_vars()函数来获取对象的所有属性。
3. 添加CSS类： 自动获取并添加文章的CSS类名，方便主题样式控制。

3. get_post()函数：文章对象的工厂

get_post()函数是WordPress中获取文章对象的核心函数。它负责从缓存或者数据库中获取文章数据，并创建WP_Post对象。

/**
 * Retrieves post data given a post ID or post object.
 *
 * See sanitize_post() for optional filtering of post data.
 *
 * @since 2.3.0
 *
 * @global WP_Post $post
 *
 * @param WP_Post|object|int|null $post Optional. Post ID or post object. Defaults to global $post.
 * @param string                  $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to a WP_Post object, an associative array, or a numeric array, respectively. Default OBJECT.
 * @param string                  $filter Optional. How to sanitize post data. Accepts 'raw', 'edit', 'db',
 *                                      or 'display'. Default 'raw'.
 * @return WP_Post|array|null WP_Post on success. Null on failure.
 */
function get_post( $post = null, $output = OBJECT, $filter = 'raw' ) {
    global $wpdb, $wp_post_types, $post;

    $_post = null;

    // 1. 参数处理和验证
    if ( empty( $post ) && isset( $GLOBALS['post'] ) ) {
        $post = $GLOBALS['post'];
    }

    if ( $post instanceof WP_Post ) {
        $_post = $post;
    } elseif ( is_object( $post ) ) {
        if ( empty( $post->filter ) || 'raw' !== $post->filter ) {
            $_post = sanitize_post( $post, $filter );
        } else {
            $_post = $post;
        }
    } else {
        $post_id = (int) $post;
        if ( empty( $post_id ) ) {
            return null;
        }

        // 2. 尝试从缓存中获取
        $_post = wp_cache_get( $post_id, 'posts' );

        if ( ! $_post ) {
            // 3. 如果缓存中没有，则从数据库中获取
            $query = $wpdb->prepare( "SELECT * FROM $wpdb->posts WHERE ID = %d LIMIT 1", $post_id );
            $_post = $wpdb->get_row( $query );

            if ( ! $_post ) {
                return null;
            }

            // 4. 将数据转换为对象
            $_post = sanitize_post( $_post, $filter );

            // 5. 将对象添加到缓存
            wp_cache_add( $post_id, $_post, 'posts' );
        }
    }

    if ( empty( $_post ) ) {
        return null;
    }

    // 6. 根据 $output 参数返回不同类型的结果
    if ( OBJECT == $output ) {
        if ( $_post instanceof WP_Post ) {
            $post_object = $_post;
        } else {
            $post_object = new WP_Post( $_post ); // 这里创建了 WP_Post 对象！
        }

        return $post_object;
    } elseif ( ARRAY_A == $output ) {
        return get_object_vars( $_post );
    } elseif ( ARRAY_N == $output ) {
        return array_values( get_object_vars( $_post ) );
    } else {
        return $_post;
    }
}

get_post()函数的工作流程可以概括为：

1. 参数处理： 处理传入的$post参数，可以是文章ID、WP_Post对象或者其他对象。
2. 缓存检查： 尝试从WordPress的对象缓存中获取文章数据。如果找到了，就直接返回。缓存是提高性能的关键！
3. 数据库查询： 如果缓存中没有，就执行SQL查询，从数据库中获取文章数据。
4. 数据清理： 对从数据库中获取的数据进行清理和过滤，防止XSS攻击等安全问题。sanitize_post()函数负责这一步。
5. 对象创建： 创建一个新的WP_Post对象，并将从数据库中获取的数据赋值给这个对象。这就是WP_Post对象诞生的关键时刻！
6. 缓存更新： 将新创建的WP_Post对象添加到缓存中，以便下次更快地获取。
7. 返回结果： 根据$output参数，返回WP_Post对象、关联数组或者数字数组。

4. sanitize_post()函数：数据的净化器

sanitize_post()函数负责对文章数据进行清理和过滤，确保数据的安全性和一致性。它会根据$filter参数，对不同的字段进行不同的处理。

/**
 * Cleans post data. Makes sure that certain post fields are valid.
 *
 * @since 2.0.0
 *
 * @param WP_Post|object|array $post Post data.
 * @param string               $filter Optional. How to sanitize post data. Accepts 'raw', 'edit', 'db',
 *                                   or 'display'. Default 'raw'.
 * @return WP_Post|object|array
 */
function sanitize_post( $post, $filter = 'raw' ) {
    // ... (代码省略) ...

    // 对不同的字段进行不同的处理
    switch ( $filter ) {
        case 'raw':
            break;
        case 'edit':
            // 用于编辑文章时的数据清理
            $post->post_title = esc_attr( $post->post_title );
            $post->post_content = esc_textarea( $post->post_content );
            $post->post_excerpt = esc_textarea( $post->post_excerpt );
            break;
        case 'db':
            // 用于插入或更新数据库时的数据清理
            $post->post_title = wp_kses_post( $post->post_title ); // 允许有限的HTML标签
            $post->post_content = wp_kses_post( $post->post_content ); // 允许有限的HTML标签
            $post->post_excerpt = wp_kses_post( $post->post_excerpt ); // 允许有限的HTML标签
            break;
        case 'display':
            // 用于显示文章时的数据清理
            $post->post_title = wp_kses_data( $post->post_title ); // 允许有限的HTML标签
            $post->post_content = wp_kses_post( $post->post_content ); // 允许有限的HTML标签
            $post->post_excerpt = wp_kses_data( $post->post_excerpt ); // 允许有限的HTML标签
            break;
        default:
            $post = apply_filters( 'sanitize_post', $post, $filter );
            break;
    }

    // ... (代码省略) ...

    return $post;
}

sanitize_post()函数会根据不同的$filter参数，使用不同的函数来清理数据，比如esc_attr()、esc_textarea()、wp_kses_post()等等。这些函数可以防止XSS攻击，并确保数据的格式正确。

5. 核心属性：WP_Post对象都有些啥？

一个WP_Post对象包含了文章的所有信息，这些信息都以属性的形式存在。一些常见的属性包括：

属性名	数据类型	描述
ID	int	文章ID，数据库中的主键。
post_author	string	文章作者ID。
post_date	string	文章发布日期，格式为YYYY-MM-DD HH:MM:SS。
post_date_gmt	string	文章发布日期的GMT时间，格式为YYYY-MM-DD HH:MM:SS。
post_content	string	文章内容。
post_title	string	文章标题。
post_excerpt	string	文章摘要。
post_status	string	文章状态，比如publish（已发布）、draft（草稿）、pending（待审核）等等。
comment_status	string	评论状态，比如open（允许评论）、closed（禁止评论）。
ping_status	string	Pingback/Trackback状态，比如open（允许）、closed（禁止）。
post_password	string	文章密码（如果设置了密码保护）。
post_name	string	文章别名，用于URL中。
to_ping	string	需要Pingback/Trackback的URL列表。
pinged	string	已经Pingback/Trackback的URL列表。
post_modified	string	文章最后修改日期，格式为YYYY-MM-DD HH:MM:SS。
post_modified_gmt	string	文章最后修改日期的GMT时间，格式为YYYY-MM-DD HH:MM:SS。
post_content_filtered	string	过滤后的文章内容。
post_parent	int	父文章ID（用于页面或者分层文章类型）。
guid	string	文章的GUID（全局唯一标识符）。
menu_order	int	菜单排序。
post_type	string	文章类型，比如post（文章）、page（页面）、attachment（附件）等等。
post_mime_type	string	文章MIME类型（用于附件）。
comment_count	string	评论数量。
filter	string	过滤器类型，通常为raw。

6. 实例演示：从ID到标题，一次完整的旅程

现在，让我们通过一个简单的例子，来演示一下如何从文章ID开始，最终获取到文章标题：

// 假设我们已经知道了文章的ID，比如是123
$post_id = 123;

// 使用 get_post() 函数获取 WP_Post 对象
$post = get_post( $post_id );

// 检查是否获取成功
if ( $post ) {
    // 从 WP_Post 对象中获取文章标题
    $title = $post->post_title;

    // 输出文章标题
    echo '文章标题：' . $title;
} else {
    echo '找不到文章！';
}

在这个例子中，我们首先使用get_post()函数，根据文章ID获取WP_Post对象。然后，我们直接访问WP_Post对象的post_title属性，就可以获取到文章标题了。

7. setup_postdata()函数：全局变量的守护神

在WordPress的主循环中，我们经常会使用setup_postdata()函数。这个函数的作用是将当前的WP_Post对象设置为全局变量$post。这使得我们可以在主题中使用像the_title()、the_content()这样的模板标签，而无需显式地传递WP_Post对象。

/**
 * Sets up the WordPress Loop global based on the current post.
 *
 * @since 1.5.0
 *
 * @global WP_Post $post
 *
 * @param WP_Post|int $post Post ID or WP_Post object.
 */
function setup_postdata( $post ) {
    global $post, $wp_query;

    if ( is_numeric( $post ) ) {
        $post = get_post( $post );
    } elseif ( empty( $post ) ) {
        $post = $wp_query->post;
    }

    if ( empty( $post ) ) {
        return;
    }

    $wp_query->in_the_loop = true;
    $wp_query->post = $post;

    if ( ! is_object( $post ) ) {
        return;
    }

    $wp_query->current_post = $wp_query->post_count - 1;

    set_postdata( $post );
}

setup_postdata()函数会：

1. 参数处理： 处理传入的$post参数，可以是文章ID或者WP_Post对象。
2. 设置全局变量： 将当前的WP_Post对象赋值给全局变量$post。
3. 更新WP_Query对象： 更新WP_Query对象的post属性和current_post属性，以便在循环中正确地显示文章信息。

8. wp_reset_postdata()函数：重置全局变量，避免冲突

在使用setup_postdata()函数之后，我们通常会在循环结束后使用wp_reset_postdata()函数。这个函数的作用是将全局变量$post重置为原始状态，避免在后面的代码中出现意外的冲突。

/**
 * Reset the WordPress loop global.
 *
 * @since 2.3.0
 *
 * @global WP_Query $wp_query
 */
function wp_reset_postdata() {
    global $wp_query;
    $wp_query->reset_postdata();
}

总结：WP_Post，WordPress的灵魂

WP_Post类是WordPress中文章对象的核心，它负责将数据库中的文章数据转换为PHP对象，并提供了一系列方法来访问和操作这些数据。理解WP_Post的实例化过程，对于深入理解WordPress的内部机制，以及定制和扩展WordPress的功能都至关重要。

希望今天的讲解能够帮助大家更好地理解WP_Post类，并在以后的WordPress开发中更加得心应手。

额外福利：一些小技巧和注意事项

• 避免直接访问数据库： 尽量使用WordPress提供的函数来获取文章数据，比如get_post()、get_posts()等等。这些函数会自动处理缓存和安全问题。
• 注意数据清理： 在显示文章数据时，一定要注意数据清理，防止XSS攻击。可以使用esc_html()、esc_attr()、wp_kses_post()等函数来清理数据。
• 合理使用缓存： WordPress的缓存机制可以大大提高性能。尽量利用缓存来减少数据库查询。
• 使用setup_postdata()和wp_reset_postdata()： 在主循环中使用这两个函数，可以确保全局变量$post的正确性。
• 自定义WP_Post类： 可以通过继承WP_Post类，来添加自定义的属性和方法，从而扩展WordPress的功能。

好了，今天的讲座就到这里。希望大家有所收获！下次有机会再见！