深入解读 WordPress `wp_delete_user()` 函数源码：删除用户时如何清理相关数据。

好嘞，各位观众老爷，今天咱们来聊聊 WordPress 里的一个狠角色 —— wp_delete_user()。这玩意儿可不是个善茬，专门负责把用户从你的网站里“抹杀”掉。但是，删除用户可不是简简单单地把数据库里那条用户信息删掉就完事儿了，还得考虑各种关联数据，不然你的网站就等着出 Bug 吧！今天，我们就来扒一扒 wp_delete_user() 的源码，看看它到底是怎么清理这些烂摊子的。

开场白：用户“消失”的艺术

咱们先来想想，一个用户在 WordPress 网站上都干些啥？发文章、写评论、上传图片、甚至还有自定义字段，这些都和用户信息息相关。如果只是简单粗暴地删除用户，这些数据就成了“孤儿”，轻则网站显示异常，重则直接报错。wp_delete_user() 的目的就是要把这些“孤儿”尽可能地处理掉，保证网站的稳定运行。

源码剖析：一步一个脚印

wp_delete_user() 的源码位于 wp-includes/user.php 文件中。咱们先来看看它的基本结构：

function wp_delete_user( $id, $reassign = null ) {
    global $wpdb, $wp_roles;

    $id = (int) $id;

    if ( ! get_userdata( $id ) ) {
        return false;
    }

    if ( ! current_user_can( 'delete_user', $id ) ) {
        return false;
    }

    if ( is_multisite() && is_super_admin( $id ) ) {
        return false;
    }

    if ( apply_filters( 'pre_delete_user', false, $id ) ) {
        return false;
    }

    do_action( 'delete_user', $id );

    // 1. Reassign posts and links.
    if ( ! is_null( $reassign ) ) {
        wp_reassign_posts( $id, $reassign );
    } else {
        wp_delete_posts( $id );
    }

    // 2. Remove all of the user's comments.
    $comments = $wpdb->get_results( $wpdb->prepare( "SELECT comment_ID FROM $wpdb->comments WHERE user_id = %d", $id ) );
    if ( $comments ) {
        foreach ( $comments as $comment ) {
            wp_delete_comment( $comment->comment_ID, true ); // Force delete.
        }
    }

    // 3. Remove all of the user's links.
    $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->links WHERE link_owner = %d", $id ) );

    // 4. Delete user meta.
    delete_user_meta( $id );

    // 5. Remove the user from the usermeta table.
    $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->usermeta WHERE user_id = %d", $id ) );

    // 6. Finally, delete the user.
    $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->users WHERE ID = %d", $id ) );

    // 7. Update caches.
    clean_user_cache( $id );

    wp_cache_delete_group( 'useremail' );
    wp_cache_delete_group( 'userlogin' );

    // 8. Remove user from roles.
    if ( $wp_roles instanceof WP_Roles ) {
        $wp_roles->remove_user_from_role( $id, '' );
    }

    do_action( 'deleted_user', $id );

    return true;
}

是不是感觉有点长？别怕，咱们一步一步来分析。

1. 参数校验与权限检查

    $id = (int) $id;

    if ( ! get_userdata( $id ) ) {
        return false;
    }

    if ( ! current_user_can( 'delete_user', $id ) ) {
        return false;
    }

    if ( is_multisite() && is_super_admin( $id ) ) {
        return false;
    }

    if ( apply_filters( 'pre_delete_user', false, $id ) ) {
        return false;
    }

    do_action( 'delete_user', $id );

这段代码主要做了以下几件事：

• 类型转换： 将用户 ID 转换为整数，防止出现意外的错误。
• 用户存在性检查： 确保要删除的用户存在，如果不存在，直接返回 false。
• 权限检查： 只有拥有 delete_user 权限的用户才能删除其他用户。这里用到了 current_user_can() 函数。
• 多站点管理员检查： 在多站点环境下，不允许删除超级管理员。
• pre_delete_user 过滤器： 这是一个钩子，允许插件在删除用户之前进行一些操作，甚至可以阻止删除操作。
• delete_user 动作： 另一个钩子，允许插件在删除用户之前执行一些操作。

2. 文章和链接的重新分配或删除

    if ( ! is_null( $reassign ) ) {
        wp_reassign_posts( $id, $reassign );
    } else {
        wp_delete_posts( $id );
    }

这是 wp_delete_user() 最重要的部分之一。它决定了如何处理被删除用户发布的文章和链接。

• $reassign 参数： 这个参数决定了文章和链接的处理方式。
  • 如果 $reassign 不为空，表示要将文章和链接重新分配给另一个用户。wp_reassign_posts() 函数负责完成这个任务。
  • 如果 $reassign 为空，表示要删除被删除用户发布的文章和链接。wp_delete_posts() 函数负责完成这个任务。

wp_reassign_posts() 函数：文章和链接的乾坤大挪移

function wp_reassign_posts( $id, $reassign ) {
    global $wpdb;

    $id       = (int) $id;
    $reassign = (int) $reassign;

    if ( ! get_userdata( $id ) || ! get_userdata( $reassign ) ) {
        return false;
    }

    do_action( 'reassign_posts', $reassign, $id );

    // Reassign posts.
    $wpdb->update( $wpdb->posts, array( 'post_author' => $reassign ), array( 'post_author' => $id ) );

    // Reassign links.
    $wpdb->update( $wpdb->links, array( 'link_owner' => $reassign ), array( 'link_owner' => $id ) );

    do_action( 'reassigned_posts', $reassign, $id );

    return true;
}

wp_reassign_posts() 函数也很简单，主要就是通过 SQL UPDATE 语句，将 wp_posts 表和 wp_links 表中 post_author 和 link_owner 字段的值从 $id (被删除用户的 ID) 更新为 $reassign (要重新分配的用户的 ID)。

wp_delete_posts() 函数：文章和链接的灰飞烟灭

function wp_delete_posts( $id ) {
    global $wpdb;

    $id = (int) $id;

    do_action( 'delete_posts', $id );

    $post_ids = $wpdb->get_col( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE post_author = %d", $id ) );

    if ( $post_ids ) {
        foreach ( $post_ids as $post_id ) {
            wp_delete_post( $post_id, true ); // Force delete.
        }
    }

    $link_ids = $wpdb->get_col( $wpdb->prepare( "SELECT link_id FROM $wpdb->links WHERE link_owner = %d", $id ) );

    if ( $link_ids ) {
        foreach ( $link_ids as $link_id ) {
            wp_delete_link( $link_id );
        }
    }

    do_action( 'deleted_posts', $id );
}

wp_delete_posts() 函数稍微复杂一些，它首先通过 SQL SELECT 语句，查询出被删除用户发布的所有文章和链接的 ID，然后循环调用 wp_delete_post() 和 wp_delete_link() 函数，将这些文章和链接彻底删除。注意，wp_delete_post() 函数的第二个参数 true 表示强制删除，即使文章处于回收站状态也会被直接删除。

3. 删除用户评论

    $comments = $wpdb->get_results( $wpdb->prepare( "SELECT comment_ID FROM $wpdb->comments WHERE user_id = %d", $id ) );
    if ( $comments ) {
        foreach ( $comments as $comment ) {
            wp_delete_comment( $comment->comment_ID, true ); // Force delete.
        }
    }

这段代码很简单，首先通过 SQL SELECT 语句，查询出被删除用户的所有评论的 ID，然后循环调用 wp_delete_comment() 函数，将这些评论彻底删除。同样，wp_delete_comment() 函数的第二个参数 true 表示强制删除。

4. 删除用户元数据

    delete_user_meta( $id );

delete_user_meta() 函数负责删除存储在 wp_usermeta 表中的用户元数据。这些元数据包括用户的昵称、头像、个人简介等等。

5. 从 wp_usermeta 表中删除用户记录

    $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->usermeta WHERE user_id = %d", $id ) );

这一步是确保 wp_usermeta 表中所有与该用户相关的信息都被清理干净。

6. 删除用户

    $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->users WHERE ID = %d", $id ) );

终于到了最后一步，通过 SQL DELETE 语句，从 wp_users 表中删除用户信息。

7. 清理缓存

    clean_user_cache( $id );

    wp_cache_delete_group( 'useremail' );
    wp_cache_delete_group( 'userlogin' );

为了确保网站显示的数据是最新的，需要清理用户相关的缓存。

• clean_user_cache() 函数负责清理单个用户的缓存。
• wp_cache_delete_group() 函数负责清理 useremail 和 userlogin 缓存组。

8. 从角色中移除用户

    if ( $wp_roles instanceof WP_Roles ) {
        $wp_roles->remove_user_from_role( $id, '' );
    }

如果网站使用了角色管理系统，需要将用户从所有角色中移除。

9. deleted_user 动作

    do_action( 'deleted_user', $id );

这是最后一个钩子，允许插件在用户删除之后执行一些操作。

总结：wp_delete_user() 的职责与边界

wp_delete_user() 函数的主要职责是：

• 删除用户信息。
• 删除或重新分配用户发布的文章和链接。
• 删除用户评论。
• 删除用户元数据。
• 清理缓存。
• 从角色中移除用户。

但是，wp_delete_user() 也有一些边界：

• 插件数据： 如果插件使用了自定义的数据表来存储用户信息，wp_delete_user() 不会删除这些数据。需要插件自己实现相应的清理逻辑。
• 第三方服务： 如果网站使用了第三方服务，例如邮件列表或社交媒体，wp_delete_user() 不会从这些服务中删除用户信息。需要手动进行删除。

代码示例：如何使用 wp_delete_user()

// 删除用户，并将文章和链接重新分配给 ID 为 1 的用户
$user_id = 123;
$reassign_user_id = 1;

$result = wp_delete_user( $user_id, $reassign_user_id );

if ( $result ) {
    echo '用户删除成功！';
} else {
    echo '用户删除失败！';
}

// 删除用户，并删除文章和链接
$user_id = 456;

$result = wp_delete_user( $user_id );

if ( $result ) {
    echo '用户删除成功！';
} else {
    echo '用户删除失败！';
}

表格总结：wp_delete_user() 清理的数据类型

数据类型	存储位置	处理方式
用户信息	wp_users	删除
文章	wp_posts	删除或重新分配
链接	wp_links	删除或重新分配
评论	wp_comments	删除
用户元数据	wp_usermeta	删除
用户角色	数据库选项	从角色中移除
用户缓存	内存	清理

高级技巧：自定义用户删除流程

如果你需要更精细地控制用户删除流程，可以使用以下技巧：

• pre_delete_user 过滤器： 在删除用户之前，可以执行一些自定义的操作，例如发送邮件通知、备份用户数据等等。
• delete_user 动作： 在删除用户之前，可以执行一些自定义的操作，例如删除用户相关的插件数据。
• deleted_user 动作： 在删除用户之后，可以执行一些自定义的操作，例如更新统计数据、清理第三方服务的数据等等。

总结的总结：

wp_delete_user() 是一个功能强大的函数，可以帮助你安全地删除用户，并清理相关的垃圾数据。但是，在使用它的时候，一定要仔细考虑 $reassign 参数，并根据实际情况，使用钩子来自定义用户删除流程。只有这样，才能确保你的网站在删除用户之后，依然能够正常运行。

好了，今天的讲座就到这里，希望大家有所收获！记住，删除用户需谨慎，且删且珍惜！