分析 WordPress `wp_get_current_user()` 函数在 WP-CLI 中的源码：如何获取当前运行命令的用户。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷，晚上好！今天咱们聊聊 WordPress 里的 wp_get_current_user() 函数，尤其是它在 WP-CLI 这个命令行工具里头的表现。这玩意儿看似简单，其实藏了不少玄机，特别是要搞清楚谁在背后偷偷摸摸地运行你的命令，那就更有意思了。

开场白：谁是真正的幕后黑手？

咱们先想想，正常情况下，WordPress 网站里，用户登录之后，wp_get_current_user() 返回的就是当前登录用户的用户信息。但在 WP-CLI 里，没了登录界面，没了 cookie，用户在哪儿呢？难道是空气吗？当然不是。 WP-CLI 得知道是谁在执行命令，这样才能做权限判断，才能知道谁应该为错误负责（开玩笑）。

wp_get_current_user() 的基本原理

先简单回顾一下 wp_get_current_user() 的基本用法。在 WordPress 网站里，它通常是这么用的：

<?php
$current_user = wp_get_current_user();

if ( 0 == $current_user->ID ) {
    // 没有用户登录
    echo '游客你好！';
} else {
    echo '你好，' . $current_user->display_name . '！';
}
?>

这段代码会根据当前登录用户的情况，输出不同的问候语。关键在于，wp_get_current_user() 函数会尝试从全局变量、session、cookie 等等地方找到当前用户信息。

WP-CLI 的特殊性：没有浏览器，怎么办？

WP-CLI 运行在命令行里，没有浏览器环境，所以那些依赖浏览器特性的东西，比如 session、cookie，就都歇菜了。那它怎么知道当前用户是谁呢？这就是咱们今天要深入探讨的地方。

源码分析：WP-CLI 如何找到当前用户

要理解 WP-CLI 如何获取当前用户，咱们得扒开它的源码看看。 WP-CLI 的源码是用 PHP 写的，所以咱们直接看 PHP 代码。

WP_CLI::get_current_user() 函数

在 WP-CLI 的代码里，通常会用到 WP_CLI::get_current_user() 函数，这个函数是 WP-CLI 内部用来获取当前用户的。它实际上是对 WordPress 的 wp_get_current_user() 的一个补充或者包装。

寻找线索：WP_CLI::bootstrap_wordpress()

在 WP-CLI 启动的时候，会执行 WP_CLI::bootstrap_wordpress() 函数，这个函数负责加载 WordPress 的核心文件，初始化 WordPress 环境。在这个过程中，它会尝试设置当前用户。

关键代码：WP_CLI::set_current_user()

WP_CLI::set_current_user() 是一个关键函数，它负责设置 WP-CLI 的当前用户。它会尝试从以下几个地方获取用户信息：

*   **`--user=<id|login|email>` 参数**： 如果在运行 WP-CLI 命令的时候，使用了 `--user` 参数，那么 WP-CLI 会直接使用这个参数指定的用户。 比如： `wp user list --user=1` 或者 `wp user list --user=admin`。
*   **`WP_CLI::get_config( 'user' )`** 从配置文件读取用户。
*   **如果上面两个都没找到，那就设置为 ID 为 0 的用户（匿名用户）**。

```php
<?php
// 简化后的代码，仅用于说明原理
class WP_CLI {
    public static function set_current_user( $user ) {
        if ( is_numeric( $user ) ) {
            $user_id = (int) $user;
        } else {
            $user_data = get_user_by( 'login', $user );
            if ( ! $user_data ) {
                $user_data = get_user_by( 'email', $user );
            }

            if ( $user_data ) {
                $user_id = $user_data->ID;
            } else {
                $user_id = 0; // 找不到用户，设置为匿名用户
            }
        }

        if ( $user_id ) {
            wp_set_current_user( $user_id );
        } else {
            wp_set_current_user( 0 ); // 匿名用户
        }
    }

    public static function get_current_user() {
        return wp_get_current_user();
    }

    public static function bootstrap_wordpress( $args = array() ) {
        // ... 加载 WordPress 核心文件 ...

        // 尝试从参数中获取用户
        if ( isset( $args['user'] ) ) {
            self::set_current_user( $args['user'] );
        }else if(self::get_config( 'user' )){
            self::set_current_user(self::get_config( 'user' ));
        }
        else {
            // 没有指定用户，设置为匿名用户
            wp_set_current_user( 0 );
        }
    }

    public static function get_config($key){
        //实际代码会从wp-cli.yml文件中读取配置，这里简化处理
        return null;
    }
}

// 模拟 WP-CLI 的启动过程
WP_CLI::bootstrap_wordpress( array( 'user' => '1' ) ); // 或者 'user' => 'admin'

$current_user = WP_CLI::get_current_user();

if ( 0 == $current_user->ID ) {
    echo '游客你好！';
} else {
    echo '你好，' . $current_user->display_name . '！';
}
?>
```

详细代码分析

上面的代码片段模拟了 WP-CLI 获取当前用户的过程。咱们来逐行分析一下：

WP_CLI::set_current_user( $user ): 这个函数接收一个 $user 参数，它可以是用户的 ID、用户名或者邮箱地址。
get_user_by( 'login', $user ) 和 get_user_by( 'email', $user ): 这两个函数是 WordPress 提供的，用于根据用户名或者邮箱地址获取用户信息。
wp_set_current_user( $user_id ): 这个函数是 WordPress 提供的，用于设置当前用户。
WP_CLI::bootstrap_wordpress( $args = array() ): 这个函数模拟了 WP-CLI 的启动过程，它会尝试从 $args 数组中获取用户，并设置当前用户。
WP_CLI::get_current_user(): 这个函数直接调用 WordPress 的 wp_get_current_user() 函数，获取当前用户信息。

代码中的注意事项

安全性：在实际的 WP-CLI 代码中，会对用户输入进行严格的验证和过滤，防止 SQL 注入等安全问题。
错误处理：如果找不到指定的用户，WP-CLI 会记录错误日志，并可能终止命令的执行。
缓存： WP-CLI 可能会对用户信息进行缓存，提高性能。

WP-CLI 配置文件的作用

WP-CLI 允许通过配置文件 (wp-cli.yml 或者 config.yml) 来设置一些全局选项，包括用户。这样，你就可以在配置文件里指定一个默认用户，而不用每次运行命令都加上 --user 参数。

表格总结

获取用户信息的来源	优先级	说明
`--user=<id\|login\|email>` 命令行参数	高	这是最高优先级的获取方式，如果指定了 `--user` 参数，WP-CLI 会直接使用这个参数指定的用户。
`WP_CLI::get_config( 'user' )` 配置文件	中	如果没有指定 `--user` 参数，WP-CLI 会尝试从配置文件中读取用户。
ID 为 0 的用户（匿名用户）	低	如果上面两种方式都找不到用户信息，WP-CLI 会将当前用户设置为 ID 为 0 的用户，也就是匿名用户。

实际应用场景

了解 WP-CLI 如何获取当前用户，对我们有什么帮助呢？

权限控制：我们可以根据当前用户来判断用户是否有权限执行某个命令。比如，只有管理员才能执行 wp plugin activate 命令。
用户身份验证：我们可以根据当前用户来验证用户身份，防止恶意操作。
审计日志：我们可以记录每个命令的执行者，方便进行审计。
自动化脚本：可以在自动化脚本中使用 --user 参数，指定脚本的执行者。

举个栗子：限制普通用户删除用户

假设我们想限制普通用户删除用户，只有管理员才能删除用户。我们可以这样做：

<?php
// 假设这是一个 WP-CLI 命令的处理函数
function my_plugin_delete_user( $args, $assoc_args ) {
    $current_user = wp_get_current_user();

    if ( ! user_can( $current_user, 'delete_users' ) ) {
        WP_CLI::error( '你没有权限删除用户！' );
    }

    $user_id = $args[0]; // 假设第一个参数是用户 ID

    wp_delete_user( $user_id );

    WP_CLI::success( '用户删除成功！' );
}

WP_CLI::add_command( 'my-plugin delete-user', 'my_plugin_delete_user' );
?>

这段代码会先获取当前用户，然后判断当前用户是否有 delete_users 权限。如果没有权限，就输出错误信息，并终止命令的执行。

进阶技巧：自定义用户提供者

如果你觉得 WP-CLI 默认的用户获取方式不够灵活，你还可以自定义用户提供者。比如，你可以从 LDAP 服务器或者其他数据库中获取用户信息。

总结：理解背后的逻辑

今天咱们深入探讨了 WP-CLI 如何获取当前用户。记住，WP-CLI 会依次尝试从命令行参数、配置文件、匿名用户这几个地方获取用户信息。掌握了这个原理，你就可以更好地控制 WP-CLI 的行为，编写更安全、更可靠的 WP-CLI 脚本。

最后的忠告：安全第一！

在使用 WP-CLI 的时候，一定要注意安全问题。尤其是涉及到用户权限的操作，一定要进行严格的验证和过滤，防止恶意攻击。永远记住，安全第一！

各位观众老爷，今天的讲座就到这里。感谢大家的收听！我们下次再见！

发表回复 取消回复

发表回复取消回复