解析 WordPress `WP_Post` 类魔术方法：`__get()` 与 `__set()` 的源码实现。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷，小的这厢有礼了！今天咱就来聊聊WordPress里一个看似神秘，实则相当实用的玩意儿：WP_Post 类的魔术方法 __get() 和 __set()。保证让各位听完之后，感觉自己又升华了！

引子：啥是魔术方法？

在PHP的世界里，魔术方法就像是隐藏在幕后的忍者，它们会在特定的时刻自动触发。你别看它们名字里带个“魔术”，其实一点都不玄乎，都是有规可循的。这些方法都以双下划线 __ 开头，像是 __construct() (构造函数)、__destruct() (析构函数) 等等。

而我们今天要讲的 __get() 和 __set() 呢，它们主要负责对象的属性读写操作。

主角登场：WP_Post 类

WP_Post 类是 WordPress 核心中用来表示文章、页面、自定义文章类型等等内容的数据结构。基本上，你在WordPress站点里看到的每一篇文章，后台编辑的每一个页面，都对应着一个 WP_Post 对象。这个对象里存储着文章的标题、内容、作者、发布时间等等各种信息。

场景设定：为什么要用魔术方法？

想象一下，如果 WP_Post 类里，每一个文章属性都直接定义成类的成员变量，那这个类得有多臃肿啊！而且，WordPress的文章属性是可以动态扩展的，比如你可以用自定义字段（Custom Fields）来给文章添加各种各样的额外信息。如果每次添加一个自定义字段，都要修改 WP_Post 类的定义，那就太麻烦了！

所以，WordPress的开发者们就巧妙地利用了 __get() 和 __set() 这两个魔术方法，来实现对文章属性的灵活访问和修改。

第一幕：__get() 的源码解析

__get() 方法会在你尝试访问一个不存在的（或者不可访问的）类属性时自动被调用。它的作用是，拦截这个访问请求，然后决定返回什么值。

让我们来看看 WP_Post 类里 __get() 方法的源码（简化版，去掉了部分兼容性代码）：

/**
 * Magic method for getting custom fields.
 *
 * @param string $key The key of the custom field.
 * @return mixed The value of the custom field, or null if not found.
 */
public function __get( $key ) {
    if ( 'id' === $key ) {
        return $this->ID;
    }

    if ( 'parent' === $key ) {
        return $this->post_parent;
    }

    if ( 'title' === $key ) {
        return get_the_title( $this->ID );
    }

    if ( 'content' === $key ) {
        return $this->post_content;
    }

    // ... 其他属性判断 ...

    // 尝试获取自定义字段
    $custom_field = get_post_meta( $this->ID, $key, true );
    if ( $custom_field ) {
        return $custom_field;
    }

    // 如果都没找到，返回 null
    return null;
}

这段代码做了什么呢？

拦截属性访问： 当你用 $post->some_attribute 访问 WP_Post 对象的属性时，如果这个属性在类中没有直接定义，PHP就会自动调用 __get() 方法。
属性判断： __get() 方法会根据你访问的属性名 $key，进行一系列的判断。
- 比如，如果 $key 是 'id'，它就返回 $this->ID（也就是文章的ID）。
- 如果 $key 是 'title'，它就调用 get_the_title() 函数来获取文章标题。
- 如果 $key 是 'content'，它就返回 $this->post_content（文章内容）。
- …等等…
自定义字段： 如果 $key 不是以上这些预定义的属性，__get() 方法还会尝试去获取自定义字段。它会调用 get_post_meta() 函数，传入文章ID和属性名 $key，来获取对应的自定义字段值。
默认返回值： 如果 $key 对应的属性或自定义字段都不存在，__get() 方法就返回 null。

举个栗子：

假设你有一篇文章，ID是 123，标题是 "Hello World"，并且你给这篇文章添加了一个自定义字段，名字是 "author"，值是 "张三"。

$post = get_post( 123 ); // 获取文章ID为123的WP_Post对象

echo $post->id;       // 输出：123  (直接访问了 $this->ID 属性)
echo $post->title;    // 输出：Hello World (调用了 get_the_title() 函数)
echo $post->author;   // 输出：张三 (获取了自定义字段 "author")
echo $post->non_existent_property; // 输出：null (属性不存在)

表格总结 __get()：

步骤	描述	涉及的函数/变量	返回值
1	尝试访问 `WP_Post` 对象的不存在或不可访问的属性 `$post->some_attribute`	`$post` , `$key`	N/A
2	`__get()` 方法被自动调用	`$key`	N/A
3	判断 `$key` 是否是预定义的属性（如 ‘id’, ‘title’, ‘content’ 等）	`$key`, `$this->ID`	如果是，返回对应的属性值（例如 `$this->ID`， `get_the_title($this->ID)`），否则进入下一步
4	尝试获取自定义字段 `get_post_meta( $this->ID, $key, true )`	`get_post_meta()`	如果找到了自定义字段，返回它的值，否则进入下一步
5	如果以上都没找到，返回 `null`	N/A	`null`

第二幕：__set() 的源码解析

__set() 方法会在你尝试给一个不存在的（或者不可访问的）类属性赋值时自动被调用。它的作用是，拦截这个赋值请求，然后决定是否允许修改。

让我们来看看 WP_Post 类里 __set() 方法的源码（简化版，去掉了部分兼容性代码）：

/**
 * Magic method for setting custom fields.
 *
 * @param string $key   The key of the custom field.
 * @param mixed  $value The value of the custom field.
 * @return void
 */
public function __set( $key, $value ) {
    if ( 'id' === $key ) {
        $this->ID = $value;
        return;
    }

    if ( 'parent' === $key ) {
        $this->post_parent = $value;
        return;
    }

    if ( 'title' === $key ) {
        wp_update_post( array( 'ID' => $this->ID, 'post_title' => $value ) );
        return;
    }

    if ( 'content' === $key ) {
        wp_update_post( array( 'ID' => $this->ID, 'post_content' => $value ) );
        return;
    }

    // ... 其他属性判断 ...

    // 设置自定义字段
    update_post_meta( $this->ID, $key, $value );
}

这段代码又做了什么呢？

拦截属性赋值： 当你用 $post->some_attribute = $some_value 给 WP_Post 对象的属性赋值时，如果这个属性在类中没有直接定义，PHP就会自动调用 __set() 方法。
属性判断： __set() 方法会根据你赋值的属性名 $key，进行一系列的判断。
- 比如，如果 $key 是 'id'，它就直接把 $value 赋值给 $this->ID。
- 如果 $key 是 'title'，它就调用 wp_update_post() 函数来更新文章标题。
- 如果 $key 是 'content'，它就调用 wp_update_post() 函数来更新文章内容。
- …等等…
自定义字段： 如果 $key 不是以上这些预定义的属性，__set() 方法会认为是你要设置自定义字段。它会调用 update_post_meta() 函数，传入文章ID、属性名 $key 和属性值 $value，来更新或添加对应的自定义字段。

注意： __set() 方法通常不会返回任何值（void）。

再举个栗子：

还是假设你有一篇文章，ID是 123，标题是 "Hello World"，并且你给这篇文章添加了一个自定义字段，名字是 "author"，值是 "张三"。

$post = get_post( 123 ); // 获取文章ID为123的WP_Post对象

$post->id = 456;       // 直接修改 $this->ID 属性
$post->title = "New Title";  // 调用 wp_update_post() 函数更新文章标题
$post->author = "李四";    // 调用 update_post_meta() 函数更新自定义字段 "author"
$post->new_property = "一些新的值"; // 调用 update_post_meta() 函数添加自定义字段 "new_property"

表格总结 __set()：

步骤	描述	涉及的函数/变量	返回值
1	尝试给 `WP_Post` 对象的不存在或不可访问的属性赋值 `$post->some_attribute = $some_value`	`$post` , `$key`, `$value`	N/A
2	`__set()` 方法被自动调用	`$key`, `$value`	N/A
3	判断 `$key` 是否是预定义的属性（如 ‘id’, ‘title’, ‘content’ 等）	`$key`, `$value`	如果是，执行相应的赋值操作（例如 `$this->ID = $value`， `wp_update_post()`），否则进入下一步
4	调用 `update_post_meta( $this->ID, $key, $value )` 来设置自定义字段	`update_post_meta()`	`void`

第三幕：__get() 和 __set() 的组合拳

__get() 和 __set() 往往是配合使用的，它们一起实现了对 WP_Post 对象属性的动态访问和修改。

读操作： 当你尝试读取一个属性时，__get() 负责找到对应的值，不管是直接从对象属性里取，还是通过函数计算得到，或者从自定义字段里获取。
写操作： 当你尝试修改一个属性时，__set() 负责把新的值保存起来，不管是直接修改对象属性，还是调用函数更新数据库，或者更新自定义字段。

总结：WP_Post 类的魔术魅力

通过 __get() 和 __set() 这两个魔术方法，WP_Post 类实现了以下几个优点：

灵活性： 可以动态地访问和修改文章的各种属性，包括自定义字段。
可扩展性： 不需要修改类的定义，就可以添加新的属性和自定义字段。
代码简洁： 避免了在类中定义大量的成员变量。

彩蛋：使用场景扩展

除了 WP_Post 类，__get() 和 __set() 这两个魔术方法在很多其他的场景下也很有用，比如：

数据验证： 你可以在 __set() 方法里对要赋值的值进行验证，确保数据的有效性。
延迟加载： 你可以在 __get() 方法里实现属性的延迟加载，只有在真正需要用到这个属性的时候才去获取它的值。
简化API： 你可以使用 __get() 和 __set() 来简化类的API，让用户可以通过简单的属性访问方式来完成复杂的操作。

好了，今天的讲座就到这里。希望各位观众老爷听得还算满意。如果觉得讲得还行，不妨点个赞，鼓励一下小的！下次有机会再跟大家聊聊WordPress的其他有趣的东西。拜拜了您嘞！

解析 WordPress `WP_Post` 类魔术方法：`get()` 与 `set()` 的源码实现。

发表回复取消回复

发表回复 取消回复

发表回复取消回复