剖析 WordPress `WP_User` 类源码：魔术方法 `__get()` 实现动态用户元数据访问。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷，大家好！今天咱们来聊聊 WordPress 里面的一个“老司机”——WP_User 类，特别是它里面那个神出鬼没的 __get() 魔术方法。别看这名字挺唬人，其实它的作用就是帮你用更简洁的方式拿到用户的各种信息，尤其是那些藏在用户元数据里的宝贝。

咱们先来热个身，了解一下 WP_User 类是个啥。

WP_User 类：用户的“代言人”

WP_User 类是 WordPress 里面的一个核心类，它代表了一个用户。只要你想获取、修改、或者删除一个用户的信息，几乎都得跟它打交道。比如，你要拿到用户的昵称、邮箱、注册时间等等，都可以通过 WP_User 类的实例来完成。

// 通过 ID 获取用户对象
$user = get_user_by( 'id', 1 ); // 获取 ID 为 1 的用户

if ( $user ) {
  echo '用户名：' . $user->user_login . '<br>';
  echo '邮箱：' . $user->user_email . '<br>';
} else {
  echo '用户不存在';
}

这段代码很简单，就是用 get_user_by() 函数通过用户 ID 获取 WP_User 对象，然后通过对象的属性（比如 $user->user_login 和 $user->user_email）来获取用户的用户名和邮箱。

但是！问题来了，WordPress 里面除了这些“官方”属性之外，还有很多用户自定义的信息，都藏在用户元数据（User Meta）里面。那怎么拿到这些元数据呢？这就要请出我们今天的主角——__get() 魔术方法了。

__get()：化腐朽为神奇的魔法棒

__get() 是 PHP 的一个魔术方法。啥叫魔术方法？就是 PHP 预先定义好的一些特殊方法，当你以特定的方式访问对象时，它们会被自动调用。 __get() 就是其中之一，它会在你访问一个不存在或不可访问的属性时被触发。

举个例子：

class MyClass {
  private $data = ['name' => '张三', 'age' => 30];

  public function __get($property) {
    if (array_key_exists($property, $this->data)) {
      return $this->data[$property];
    } else {
      return null; // 或者抛出一个异常
    }
  }
}

$obj = new MyClass();
echo $obj->name; // 输出：张三
echo $obj->age;  // 输出：30
echo $obj->address; // 输出：null

在这个例子中，MyClass 类里面有一个私有的 $data 数组，存储了一些数据。当我们尝试访问 $obj->name 和 $obj->age 时，由于这两个属性在类中不存在，所以 PHP 会自动调用 __get() 方法。 __get() 方法检查 $data 数组中是否存在对应的键，如果存在就返回对应的值，否则返回 null。

WP_User 类的 __get()：访问用户元数据的秘密通道

在 WP_User 类中，__get() 方法的作用就是让你能够像访问普通属性一样，访问用户的元数据。它的实现大概是这样的（为了方便理解，这里简化了一些代码）：

class WP_User {
  public $data;  // 用户数据，比如 user_login, user_email 等
  public $ID;    // 用户 ID

  public function __get( $key ) {
    // 1. 检查是否是内置属性，如果是，直接返回
    if ( isset( $this->data->$key ) ) {
      return $this->data->$key;
    }

    // 2. 如果不是内置属性，尝试从用户元数据中获取
    $value = get_user_meta( $this->ID, $key, true ); // 第三个参数 true 表示返回单个值

    // 3. 返回获取到的值
    return $value;
  }
}

这段代码做了三件事：

检查是否是内置属性： 先看看你要访问的属性是不是 WP_User 类自身定义的属性，比如 user_login、user_email 这些。如果是，就直接返回。
尝试从用户元数据中获取： 如果不是内置属性，就用 get_user_meta() 函数从用户元数据中获取。 get_user_meta() 函数是 WordPress 提供的一个用于获取用户元数据的函数，它需要三个参数：用户 ID、元数据键名、以及一个布尔值，表示是否返回单个值。
返回获取到的值： 把从用户元数据中获取到的值返回。

有了这个 __get() 方法，你就可以这样访问用户的元数据了：

$user = get_user_by( 'id', 1 );

// 假设用户元数据中有一个键名为 'nickname' 的数据
$nickname = $user->nickname; // 相当于调用了 get_user_meta( 1, 'nickname', true );

echo '昵称：' . $nickname;

是不是很方便？你不用每次都调用 get_user_meta() 函数，直接像访问普通属性一样访问就行了。

深入剖析 WP_User 类的 __get() 方法

现在，咱们来更深入地剖析一下 WP_User 类的 __get() 方法，看看它在实际代码中是如何实现的。

首先，找到 WP_User 类的定义。你可以在 WordPress 的 wp-includes/class-wp-user.php 文件中找到它。然后，找到 __get() 方法的定义。你会发现，实际的代码比我上面简化后的代码要复杂一些，因为它还考虑了一些其他情况，比如缓存、插件的钩子等等。

下面是 WP_User 类中 __get() 方法的简化版（去掉了部分代码，只保留了核心逻辑）：

/**
 * Magic method for accessing custom fields.
 *
 * @since 2.0.0
 *
 * @param string $key Key to search for.
 * @return mixed The field value if found, null otherwise.
 */
public function __get( $key ) {
  if ( isset( $this->data->$key ) ) {
    return $this->data->$key;
  }

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

  if ( isset( $this->$key ) ) {
    return $this->$key;
  }

  // Back compat for subscribers.
  if ( 'level' === $key && 'subscriber' === $this->roles[0] ) {
    return 0;
  }

  $value = get_user_meta( $this->ID, $key, true );

  if ( $value ) {
    $this->$key = $value; // Store the value in the object for future use.
  }

  return $value;
}

这个代码做了以下几件事：

检查 $this->data： 还是先检查 $this->data 属性，看看是否存在对应的键。 $this->data 存储的是用户的基本信息，比如用户名、邮箱等等。
检查 $this->filter： 检查 $key 是否是 filter。这个属性用于存储用户的过滤信息，一般情况下不会用到。
检查 $this->$key： 检查对象本身是否存在 $key 属性。这主要是为了处理一些特殊情况，比如插件动态添加的属性。
兼容性处理： 对订阅者角色（subscriber）的 level 属性进行兼容性处理。在 WordPress 的早期版本中，level 属性用于表示用户的权限级别，现在已经不再使用。
获取用户元数据： 如果以上条件都不满足，就调用 get_user_meta() 函数获取用户元数据。
缓存结果： 如果从用户元数据中获取到了值，就把这个值存储到对象本身，以便下次访问时可以直接从对象中获取，提高性能。这就是 $this->$key = $value; 这行代码的作用。
返回结果： 返回获取到的值。

__get() 的优点和缺点

__get() 方法的优点很明显：

简化代码： 让你能够用更简洁的方式访问用户的元数据，不用每次都调用 get_user_meta() 函数。
提高可读性： 代码更加易读，更容易理解。

但是，__get() 方法也有一些缺点：

性能问题： 每次访问不存在的属性都会触发 __get() 方法，这会带来一定的性能开销。虽然 WP_User 类在 __get() 方法中对结果进行了缓存，但是第一次访问仍然需要调用 get_user_meta() 函数。
可维护性问题： 由于 __get() 方法会拦截所有对不存在属性的访问，因此可能会导致一些意想不到的问题。例如，如果你不小心写错了属性名，__get() 方法会尝试从用户元数据中获取，而不会报错，这可能会让你很难找到问题所在。

最佳实践：如何正确使用 __get()

为了避免 __get() 方法带来的问题，你应该遵循以下最佳实践：

明确知道你要访问的属性是否存在： 在使用 __get() 方法之前，最好先确认你要访问的属性是否存在。你可以使用 metadata_exists( 'user', $user->ID, $key ) 函数来检查用户元数据中是否存在某个键。
避免过度使用： 不要过度依赖 __get() 方法。如果你的代码中经常需要访问同一个用户元数据，最好将其缓存起来，避免重复调用 get_user_meta() 函数。
使用明确的方法： 对于一些常用的用户元数据，最好使用明确的方法来访问。例如，你可以创建一个专门用于获取用户昵称的方法：

class WP_User {
  // ...

  public function get_nickname() {
    return get_user_meta( $this->ID, 'nickname', true );
  }

  // ...
}

$user = get_user_by( 'id', 1 );
$nickname = $user->get_nickname(); // 使用明确的方法获取昵称

echo '昵称：' . $nickname;

这样做的好处是，代码更加清晰易懂，而且可以更好地控制访问用户元数据的方式。

总结

WP_User 类的 __get() 方法是一个非常方便的工具，它可以让你用更简洁的方式访问用户的元数据。但是，在使用 __get() 方法时，你需要注意性能和可维护性问题，并遵循最佳实践，才能充分发挥它的优势，避免潜在的风险。

希望今天的讲座对你有所帮助！记住，理解源码是提升编程能力的关键，只有深入了解 WordPress 的内部机制，才能写出更高效、更健壮的代码。感谢大家！

发表回复 取消回复

发表回复取消回复