WordPress源码深度解析之：`WordPress`的`wp_usermeta`表：如何为用户添加自定义数据。

各位观众，晚上好！我是今晚的主讲人，今天咱们来聊聊WordPress里一个非常实用，但也常常被忽略的家伙——wp_usermeta表。 别看它名字长，其实就是个专门用来给WordPress用户“贴标签”的地方。 啥意思呢？ 就是说，除了用户ID、用户名、密码这些基本信息之外，你想给每个用户自定义一些额外的数据，比如用户的生日、爱好、居住地、甚至是他/她最喜欢的冰淇淋口味（当然，这个有点过分了），都可以往这里塞。

一、wp_usermeta 表的结构：扒一扒它的“内心”

先来简单认识一下wp_usermeta表的结构。 把它想象成一个 Excel 表格，它大概长这样:

字段名	数据类型	描述
umeta_id	BIGINT	自增长的 ID，唯一标识每一行数据。
user_id	BIGINT	关联的用户 ID，指向 wp_users 表中的 ID 字段。
meta_key	VARCHAR	元数据的键名，也就是你给这个数据的“标签”。 比如 birthday，favorite_ice_cream。
meta_value	LONGTEXT	元数据的值，也就是你给这个“标签”的具体内容。 比如 1990-01-01，chocolate。

是不是很简单？ 其实就四个字段，用 user_id 把用户和元数据关联起来，然后用 meta_key 和 meta_value 存储键值对。

二、CRUD 操作：增删改查，一个都不能少

既然是数据库表，那增删改查(CRUD)是基本操作。 WordPress 提供了专门的函数来操作 wp_usermeta 表，我们不用直接写 SQL 语句，方便又安全。

1. 增加（Create）：给用户添加元数据

   使用 add_user_meta() 函数。 语法如下：

   add_user_meta( int $user_id, string $meta_key, mixed $meta_value, bool $unique = false ) : int|false

   • $user_id: 用户的 ID。
   • $meta_key: 元数据的键名。
   • $meta_value: 元数据的值。
   • $unique: 是否唯一。 如果设置为 true，则同一个用户只能有一个相同的 meta_key。 默认为 false，允许同一个用户有多个相同的 meta_key。

   举个例子，给 ID 为 1 的用户添加一个生日信息：

   $user_id = 1;
   $meta_key = 'birthday';
   $meta_value = '1990-01-01';
   
   $result = add_user_meta( $user_id, $meta_key, $meta_value, true );
   
   if ( $result ) {
      echo '生日信息添加成功！';
   } else {
      echo '生日信息添加失败！';
   }

   这里 $unique 设置为 true，确保每个用户只有一个生日信息。 add_user_meta 会返回新添加的 meta ID，失败则返回 false。

2. 查询（Read）：获取用户的元数据

   使用 get_user_meta() 函数。 语法如下：

   get_user_meta( int $user_id, string $meta_key = '', bool $single = false ) : mixed

   • $user_id: 用户的 ID。
   • $meta_key: 元数据的键名。 如果为空，则返回所有元数据。
   • $single: 是否返回单个值。 如果设置为 true，则只返回第一个匹配的值。 默认为 false，返回一个数组。

   获取 ID 为 1 的用户的生日信息：

   $user_id = 1;
   $meta_key = 'birthday';
   
   $birthday = get_user_meta( $user_id, $meta_key, true );
   
   if ( $birthday ) {
      echo '生日：' . $birthday;
   } else {
      echo '没有找到生日信息！';
   }

   这里 $single 设置为 true，因为我们只需要返回一个生日信息。

   获取 ID 为 1 的用户的所有元数据：

   $user_id = 1;
   $all_meta = get_user_meta( $user_id );
   
   echo '<pre>';
   print_r( $all_meta );
   echo '</pre>';

   这将返回一个包含所有元数据的数组。

3. 更新（Update）：修改用户的元数据

   使用 update_user_meta() 函数。 语法如下：

   update_user_meta( int $user_id, string $meta_key, mixed $meta_value, mixed $prev_value = '' ) : int|bool

   • $user_id: 用户的 ID。
   • $meta_key: 元数据的键名。
   • $meta_value: 元数据的新值。
   • $prev_value: 旧值。 如果指定了旧值，则只有当当前值与旧值匹配时，才会更新。 默认为空，表示不检查旧值。

   修改 ID 为 1 的用户的生日信息：

   $user_id = 1;
   $meta_key = 'birthday';
   $new_birthday = '1992-02-02';
   
   $result = update_user_meta( $user_id, $meta_key, $new_birthday );
   
   if ( $result ) {
      echo '生日信息更新成功！';
   } else {
      echo '生日信息更新失败！';
   }

   如果 wp_usermeta 表中不存在相应的 meta_key 和 user_id 组合，update_user_meta 会自动插入一条新记录，相当于 add_user_meta。

   使用 $prev_value 参数进行条件更新：

   $user_id = 1;
   $meta_key = 'birthday';
   $old_birthday = '1990-01-01';
   $new_birthday = '1992-02-02';
   
   $result = update_user_meta( $user_id, $meta_key, $new_birthday, $old_birthday );
   
   if ( $result ) {
      echo '生日信息更新成功！';
   } else {
      echo '生日信息更新失败！';
   }

   只有当用户的生日是 1990-01-01 时，才会更新为 1992-02-02。

4. 删除（Delete）：删除用户的元数据

   使用 delete_user_meta() 函数。 语法如下：

   delete_user_meta( int $user_id, string $meta_key, mixed $meta_value = '' ) : bool

   • $user_id: 用户的 ID。
   • $meta_key: 元数据的键名。
   • $meta_value: 元数据的值。 如果指定了值，则只有当 meta_key 和 meta_value 都匹配时，才会删除。 默认为空，表示删除所有匹配的 meta_key。

   删除 ID 为 1 的用户的生日信息：

   $user_id = 1;
   $meta_key = 'birthday';
   
   $result = delete_user_meta( $user_id, $meta_key );
   
   if ( $result ) {
      echo '生日信息删除成功！';
   } else {
      echo '生日信息删除失败！';
   }

   删除 ID 为 1 的用户，meta_key 为 birthday，且 meta_value 为 1990-01-01 的记录：

   $user_id = 1;
   $meta_key = 'birthday';
   $meta_value = '1990-01-01';
   
   $result = delete_user_meta( $user_id, $meta_key, $meta_value );
   
   if ( $result ) {
      echo '生日信息删除成功！';
   } else {
      echo '生日信息删除失败！';
   }

   注意: 如果同一个用户有多个相同的 meta_key，delete_user_meta 默认会删除所有匹配的记录。

三、实战演练：如何在WordPress主题中使用 wp_usermeta

光说不练假把式，咱们来个实际的例子。 假设我们要给每个用户添加一个“个人简介”字段，并在用户个人资料页面显示出来。

1. 添加自定义字段到用户个人资料页面

   可以使用 show_user_profile 和 edit_user_profile 钩子来添加自定义字段。 打开你的主题的 functions.php 文件，添加以下代码：

   /**
   * 添加自定义字段到用户个人资料页面
   */
   function my_custom_user_profile_fields( $user ) {
      ?>
      <h3>个人简介</h3>
   
      <table class="form-table">
          <tr>
              <th><label for="description">个人简介</label></th>
              <td>
                  <textarea name="description" id="description" rows="5" cols="50" class="regular-text"><?php echo esc_textarea( get_user_meta( $user->ID, 'description', true ) ); ?></textarea><br />
                  <span class="description">请输入您的个人简介。</span>
              </td>
          </tr>
      </table>
      <?php
   }
   add_action( 'show_user_profile', 'my_custom_user_profile_fields' );
   add_action( 'edit_user_profile', 'my_custom_user_profile_fields' );
   
   /**
   * 保存自定义字段
   */
   function my_save_custom_user_profile_fields( $user_id ) {
   
      if ( ! current_user_can( 'edit_user', $user_id ) ) {
          return false;
      }
   
      if ( isset( $_POST['description'] ) ) {
          update_user_meta( $user_id, 'description', sanitize_textarea_field( $_POST['description'] ) );
      }
   }
   add_action( 'personal_options_update', 'my_save_custom_user_profile_fields' );
   add_action( 'edit_user_profile_update', 'my_save_custom_user_profile_fields' );

   这段代码会在用户个人资料页面添加一个“个人简介”的文本框。 sanitize_textarea_field() 函数用于对输入的数据进行安全过滤。

2. 在主题中显示个人简介

   现在，我们可以在主题的任何地方显示用户的个人简介了。 比如，在作者信息模板中：

   <?php
   $author_id = get_the_author_meta( 'ID' );
   $description = get_user_meta( $author_id, 'description', true );
   
   if ( $description ) {
      echo '<div class="author-description">';
      echo '<p>' . esc_html( $description ) . '</p>';
      echo '</div>';
   }
   ?>

   这段代码会获取当前文章作者的 ID，然后从 wp_usermeta 表中获取 description 字段的值，并显示出来。 esc_html() 函数用于对输出的数据进行安全转义，防止 XSS 攻击。

四、高级技巧：序列化和对象存储

wp_usermeta 表的 meta_value 字段是 LONGTEXT 类型，可以存储任意长度的字符串。 但如果我们想存储更复杂的数据结构，比如数组或对象怎么办？

这时就需要用到序列化。 PHP 提供了 serialize() 和 unserialize() 函数来实现数据的序列化和反序列化。

• 序列化：将数组或对象转换为字符串

  $my_array = array(
     'name' => 'John Doe',
     'age' => 30,
     'city' => 'New York'
  );
  
  $serialized_data = serialize( $my_array );
  
  echo $serialized_data;
  // 输出：a:3:{s:4:"name";s:8:"John Doe";s:3:"age";i:30;s:4:"city";s:8:"New York";}
  
  add_user_meta( 1, 'my_data', $serialized_data );

• 反序列化：将字符串转换回数组或对象

  $serialized_data = get_user_meta( 1, 'my_data', true );
  $my_array = unserialize( $serialized_data );
  
  echo '<pre>';
  print_r( $my_array );
  echo '</pre>';

  这样就可以方便地存储和读取复杂的数据结构了。

五、性能优化：避免滥用 wp_usermeta

wp_usermeta 表虽然很方便，但也不是万能的。 如果滥用，会导致性能问题。 比如，频繁的查询和更新操作会增加数据库的负担。

以下是一些优化建议：

• 避免存储大量数据： wp_usermeta 表不适合存储大量数据。 如果需要存储大量数据，应该考虑使用自定义数据表。
• 使用索引： 如果经常根据 meta_key 查询数据，可以考虑给 meta_key 字段添加索引。
• 缓存数据： 对于不经常变化的数据，可以使用 WordPress 的对象缓存 API 来缓存数据。
• 批量操作： 尽量使用批量操作来减少数据库的查询次数。 比如，可以使用 update_metadata() 函数来批量更新元数据。

六、安全注意事项：防止恶意攻击

wp_usermeta 表存储着用户的敏感信息，因此必须注意安全。

• 数据验证和过滤： 对用户输入的数据进行严格的验证和过滤，防止 XSS 攻击和 SQL 注入。
• 权限控制： 只有管理员才能修改用户的元数据。
• 加密存储： 对于敏感数据，可以使用加密算法进行加密存储。

七、总结：wp_usermeta 的正确打开方式

wp_usermeta 表是 WordPress 中一个非常灵活和强大的工具，可以用来存储用户的自定义数据。 但要合理使用，注意性能和安全问题。

记住以下几点：

• 了解 wp_usermeta 表的结构和原理。
• 掌握 CRUD 操作的函数。
• 学会序列化和反序列化。
• 注意性能优化和安全问题。

好了，今天的讲座就到这里。 希望大家对 wp_usermeta 表有了更深入的了解。 感谢大家的收听！ 祝大家编程愉快！