阐述 WordPress `wp_update_user()` 函数源码：更新用户数据时如何处理密码和元数据。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

好嘞，各位观众老爷，今天咱们来聊聊 WordPress 里一个挺重要的函数，wp_update_user()。这玩意儿就像 WordPress 用户管理系统里的变形金刚，负责更新用户数据，既能改名字、邮箱，又能处理密码和元数据。

咱们今天就扒开它的源码，看看这变形金刚是怎么运作的，重点关注它怎么更新密码和元数据，保证你听完之后，也能自己动手改造它。

一、开场白：wp_update_user() 到底是干啥的？

简单来说，wp_update_user() 函数用于更新 WordPress 用户的各种信息。你可以通过它来：

修改用户名、邮箱地址
更新用户的密码
改变用户的角色
添加、修改或删除用户的元数据 (metadata)

这函数功能强大，但用起来也要小心，用不好容易出问题。所以，咱们得先了解它的内部机制。

二、源码剖析：wp_update_user() 的骨架

wp_update_user() 函数的源码比较长，为了方便理解，咱们把它拆解成几个核心部分来分析。

function wp_update_user( $userdata ) {
    global $wpdb;

    // 1. 参数校验和预处理
    $userdata = wp_parse_args( $userdata );

    // 2. 获取用户 ID
    $id = 0;
    if ( ! empty( $userdata['ID'] ) ) {
        $id = absint( $userdata['ID'] );
    } elseif ( ! empty( $userdata['id'] ) ) {
        $id = absint( $userdata['id'] );
        $userdata['ID'] = $id;
    }

    if ( ! $id ) {
        return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
    }

    $user = get_userdata( $id );

    if ( ! $user ) {
        return new WP_Error( 'invalid_user', __( 'Invalid user.' ) );
    }

    // 3. 权限检查
    if ( ! current_user_can( 'edit_user', $id ) ) {
        return new WP_Error( 'edit_users', __( 'Sorry, you are not allowed to edit this user.' ) );
    }

    // 4. 准备更新的数据
    $data = array();

    if ( isset( $userdata['user_login'] ) ) {
        $data['user_login'] = $userdata['user_login'];
    }

    if ( isset( $userdata['user_pass'] ) ) {
        $data['user_pass'] = $userdata['user_pass'];
    }

    if ( isset( $userdata['user_email'] ) ) {
        $data['user_email'] = $userdata['user_email'];
    }

    if ( isset( $userdata['user_url'] ) ) {
        $data['user_url'] = $userdata['user_url'];
    }

    if ( isset( $userdata['display_name'] ) ) {
        $data['display_name'] = $userdata['display_name'];
    }

    if ( isset( $userdata['nickname'] ) ) {
        $data['nickname'] = $userdata['nickname'];
    }

    if ( isset( $userdata['first_name'] ) ) {
        $data['first_name'] = $userdata['first_name'];
    }

    if ( isset( $userdata['last_name'] ) ) {
        $data['last_name'] = $userdata['last_name'];
    }

    if ( isset( $userdata['description'] ) ) {
        $data['description'] = $userdata['description'];
    }

    if ( isset( $userdata['locale'] ) ) {
        $data['locale'] = $userdata['locale'];
    }

    if ( isset( $userdata['rich_editing'] ) ) {
        $data['rich_editing'] = $userdata['rich_editing'];
    }

    if ( isset( $userdata['syntax_highlighting'] ) ) {
        $data['syntax_highlighting'] = $userdata['syntax_highlighting'];
    }

    // 5. 更新用户表
    if ( ! empty( $data ) ) {
        $where = array( 'ID' => $id );
        $updated = $wpdb->update( $wpdb->users, $data, $where );
    }

    // 6. 处理密码更新
    if ( isset( $userdata['user_pass'] ) ) {
        wp_set_password( $userdata['user_pass'], $id );
    }

    // 7. 处理用户角色
    if ( isset( $userdata['role'] ) ) {
        wp_update_user_roles( $id, $userdata['role'] );
    }

    // 8. 处理元数据更新
    if ( isset( $userdata['meta_input'] ) && is_array( $userdata['meta_input'] ) ) {
        foreach ( $userdata['meta_input'] as $key => $value ) {
            update_user_meta( $id, $key, $value );
        }
    }

    // 9. 清理缓存
    clean_user_cache( $id );

    // 10. 触发动作钩子
    do_action( 'profile_update', $id, $user->data );

    return $id;
}

咱们把这段代码分成几个部分，逐个击破：

参数校验和预处理: 这一步主要是确保传入的数据是有效的，并进行一些必要的格式化。wp_parse_args() 函数会将传入的 $userdata 数组与默认参数合并，确保所有需要的参数都存在。
获取用户 ID: 确定要更新哪个用户，如果 $userdata 中没有 ID，或者 ID 无效，函数会返回错误。
权限检查: 检查当前用户是否有权限编辑目标用户的信息。这是安全的关键，避免恶意用户篡改其他用户的数据。
准备更新的数据: 从 $userdata 数组中提取需要更新的字段，例如 user_email、display_name 等。
更新用户表: 使用 $wpdb->update() 函数更新 wp_users 表中的数据。
处理密码更新: 如果 $userdata 中包含 user_pass 字段，则调用 wp_set_password() 函数更新用户的密码。
处理用户角色: 如果 $userdata 中包含 role 字段，则调用 wp_update_user_roles() 函数更新用户的角色。
处理元数据更新: 如果 $userdata 中包含 meta_input 字段，则遍历该数组，使用 update_user_meta() 函数更新用户的元数据。
清理缓存: 更新用户信息后，需要清理缓存，确保后续操作获取到最新的数据。
触发动作钩子: 触发 profile_update 动作钩子，允许其他插件或主题在用户信息更新后执行自定义操作。

三、密码更新：wp_set_password() 的秘密

密码更新这块，wp_set_password() 函数扮演着关键角色。它可不是简单地把明文密码存到数据库里，而是经过一系列复杂的加密处理，保证用户密码的安全。

function wp_set_password( $password, $user_id ) {
    global $wpdb;

    $user_id = absint( $user_id );

    $hash = wp_hash_password( $password );

    /**
     * Fires before the user's password is changed.
     *
     * @since 2.5.0
     *
     * @param int $user_id The user ID.
     */
    do_action( 'password_personal_options_update', $user_id );

    $wpdb->update( $wpdb->users, array( 'user_pass' => $hash, 'user_activation_key' => '' ), array( 'ID' => $user_id ) );

    wp_cache_delete( $user_id, 'users' );

    /**
     * Fires after the user's password has been changed.
     *
     * @since 2.5.0
     *
     * @param int $user_id The user ID.
     */
    do_action( 'after_password_reset', $user_id );
}

核心步骤：

密码哈希: 使用 wp_hash_password() 函数对密码进行哈希处理。这个函数使用 bcrypt 算法，是一种非常安全的密码哈希算法。
更新数据库: 将哈希后的密码存储到 wp_users 表的 user_pass 字段中。同时，清空 user_activation_key 字段，防止激活链接泄露密码。

wp_hash_password() 到底做了啥？

wp_hash_password() 函数是 WordPress 密码安全的核心。它使用 bcrypt 算法，并加入了 salt 值，使得即使数据库泄露，攻击者也很难破解用户的密码。

function wp_hash_password( $password ) {
    global $wp_hasher;

    if ( empty( $wp_hasher ) ) {
        require_once ABSPATH . WPINC . '/class-phpass.php';
        $wp_hasher = new PasswordHash( 8, true );
    }

    return $wp_hasher->HashPassword( trim( $password ) );
}

这个函数实际上是调用了 PasswordHash 类（位于 wp-includes/class-phpass.php 文件中）的 HashPassword() 方法来完成密码哈希的。

四、元数据更新：update_user_meta() 的舞台

元数据就像是用户的附加属性，可以存储各种各样的信息，比如用户的个人简介、社交账号链接等等。update_user_meta() 函数就是用来更新这些元数据的。

function update_user_meta( $user_id, $meta_key, $meta_value, $prev_value = '' ) {
    return update_metadata( 'user', $user_id, $meta_key, $meta_value, $prev_value );
}

实际上，update_user_meta() 函数只是简单地调用了 update_metadata() 函数，并将对象类型设置为 ‘user’。update_metadata() 函数才是真正干活的。

update_metadata() 是个啥？

update_metadata() 函数是一个通用的元数据更新函数，可以用于更新各种类型的对象的元数据，比如文章、用户、分类等等。

function update_metadata( $meta_type, $object_id, $meta_key, $meta_value, $prev_value = '' ) {
    global $wpdb;

    if ( ! $meta_type || ! $meta_key || ! is_numeric( $object_id ) ) {
        return false;
    }

    $object_id = absint( $object_id );

    $table = _get_meta_table( $meta_type );

    if ( ! $table ) {
        return false;
    }

    $column = sanitize_key( $meta_type . '_id' );

    // 1. 检查是否已经存在
    $check = apply_filters( "get_{$meta_type}_metadata", null, $object_id, $meta_key, true );
    if ( ! is_null( $check ) && $check ) {
        $has_value = true;
    } else {
        $has_value = $wpdb->get_var( $wpdb->prepare( "SELECT meta_id FROM {$table} WHERE meta_key = %s AND {$column} = %d", $meta_key, $object_id ) );
    }

    // 2. 处理更新
    if ( $has_value ) {
        // 2.1 如果提供了 $prev_value，则检查是否匹配
        if ( '' !== $prev_value ) {
            $old_value = get_metadata( $meta_type, $object_id, $meta_key, true );
            if ( $old_value !== $prev_value ) {
                return false;
            }
        }

        // 2.2 更新数据
        $meta_value = maybe_serialize( $meta_value );
        $data = compact( 'meta_value' );
        $where = array( 'meta_key' => $meta_key, $column => $object_id );
        $updated = $wpdb->update( $table, $data, $where );

        if ( ! $updated ) {
            return false;
        }

        wp_cache_delete( $object_id, $meta_type . '_meta' );

        do_action( "updated_{$meta_type}_meta", $object_id, $meta_id, $meta_key, $meta_value );

        return true;
    } else {
        // 3. 处理新增
        $meta_value = maybe_serialize( $meta_value );
        $data = array(
            $column     => $object_id,
            'meta_key'   => $meta_key,
            'meta_value' => $meta_value,
        );
        $format = array( '%d', '%s', '%s' );
        $inserted = $wpdb->insert( $table, $data, $format );

        if ( ! $inserted ) {
            return false;
        }

        $meta_id = $wpdb->insert_id;

        wp_cache_delete( $object_id, $meta_type . '_meta' );

        do_action( "added_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $meta_value );

        return $meta_id;
    }
}

主要逻辑：

参数校验: 确保传入的参数是有效的。
获取元数据表: 根据 $meta_type 获取对应的元数据表名。例如，如果 $meta_type 是 ‘user’，则表名是 wp_usermeta。
检查是否已经存在: 查询数据库，检查是否存在具有相同 $meta_key 和 $object_id 的元数据。
处理更新或新增:
- 如果元数据已经存在，则更新 meta_value 字段。
- 如果元数据不存在，则插入一条新的记录。
序列化数据: 在存储 meta_value 之前，使用 maybe_serialize() 函数对其进行序列化。这是因为 meta_value 可以是任何类型的数据，包括数组和对象。
清理缓存: 更新或新增元数据后，需要清理缓存。
触发动作钩子: 触发 updated_{$meta_type}_meta 或 added_{$meta_type}_meta 动作钩子，允许其他插件或主题执行自定义操作。

五、实战演练：用 wp_update_user() 更新用户数据

理论讲了一大堆，现在咱们来点实际的，用 wp_update_user() 函数来更新用户数据。

场景 1：修改用户的邮箱地址

$userdata = array(
    'ID'         => 1, // 用户 ID
    'user_email' => '[email protected]',
);

$user_id = wp_update_user( $userdata );

if ( is_wp_error( $user_id ) ) {
    echo 'Error: ' . $user_id->get_error_message();
} else {
    echo 'User email updated successfully!';
}

场景 2：修改用户的密码

$userdata = array(
    'ID'        => 1, // 用户 ID
    'user_pass' => 'new_password',
);

$user_id = wp_update_user( $userdata );

if ( is_wp_error( $user_id ) ) {
    echo 'Error: ' . $user_id->get_error_message();
} else {
    echo 'User password updated successfully!';
}

场景 3：添加用户的元数据

$userdata = array(
    'ID'         => 1, // 用户 ID
    'meta_input' => array(
        'phone_number' => '123-456-7890',
        'city'         => 'New York',
    ),
);

$user_id = wp_update_user( $userdata );

if ( is_wp_error( $user_id ) ) {
    echo 'Error: ' . $user_id->get_error_message();
} else {
    echo 'User metadata updated successfully!';
}

表格总结：wp_update_user() 参数说明

参数名	类型	描述
`ID`	int	必需。要更新的用户的 ID。
`user_login`	string	用户的登录名。
`user_pass`	string	用户的密码。
`user_email`	string	用户的邮箱地址。
`user_url`	string	用户的个人网站 URL。
`display_name`	string	用户的显示名称。
`nickname`	string	用户的昵称。
`first_name`	string	用户的名字。
`last_name`	string	用户的姓氏。
`description`	string	用户的个人简介。
`role`	string	用户的角色。
`meta_input`	array	用于更新用户元数据的数组。数组的键是元数据的键名，值是元数据的值。
`locale`	string	用户区域设置。
`rich_editing`	string	是否启用可视化编辑器 (true/false)。
`syntax_highlighting`	string	是否启用语法高亮 (true/false)。

六、注意事项：使用 wp_update_user() 的坑

权限问题: 确保当前用户有足够的权限来更新目标用户的信息。
数据校验: 在使用 wp_update_user() 之前，对传入的数据进行校验，防止恶意数据破坏数据库。
密码安全: 永远不要以明文方式存储密码。使用 wp_hash_password() 函数对密码进行哈希处理。
元数据序列化: 注意元数据的序列化问题。如果元数据是数组或对象，需要使用 maybe_serialize() 函数进行序列化。
动作钩子: 利用 profile_update 动作钩子，可以在用户信息更新后执行自定义操作，例如发送通知邮件。

七、总结：wp_update_user() 的价值

wp_update_user() 函数是 WordPress 用户管理系统中的一个核心函数，它提供了强大的功能，可以方便地更新用户的各种信息。

简化开发: 避免直接操作数据库，提高开发效率。
保证安全: 内置的权限检查和密码哈希机制，保证用户数据的安全。
扩展性强: 通过动作钩子，可以方便地扩展 wp_update_user() 的功能。

掌握了 wp_update_user() 函数的用法，你就可以更好地管理 WordPress 用户，开发出更强大的用户管理功能。

好了，今天的讲座就到这里。希望大家有所收获！如果有任何问题，欢迎留言讨论。咱们下期再见！

发表回复 取消回复

发表回复取消回复