wp-cookie生成源码解析

2021-07-31  本文已影响0人  三米板

首先我们找到设置cookie的位置:

wp-includes/pluggable.php

我们找到方法,我们看到了在这个方法中设置了cookie

function wp_set_auth_cookie( $user_id, $remember = false, $secure = '', $token = '' )
//...
$auth_cookie      = wp_generate_auth_cookie( $user_id, $expiration, $scheme, $token );
        $logged_in_cookie = wp_generate_auth_cookie( $user_id, $expiration, 'logged_in', $token );
//...
        setcookie( $auth_cookie_name, $auth_cookie, $expire, PLUGINS_COOKIE_PATH, COOKIE_DOMAIN, $secure, true );
        setcookie( $auth_cookie_name, $auth_cookie, $expire, ADMIN_COOKIE_PATH, COOKIE_DOMAIN, $secure, true );
        setcookie( LOGGED_IN_COOKIE, $logged_in_cookie, $expire, COOKIEPATH, COOKIE_DOMAIN, $secure_logged_in_cookie, true );
        if ( COOKIEPATH != SITECOOKIEPATH ) {
            setcookie( LOGGED_IN_COOKIE, $logged_in_cookie, $expire, SITECOOKIEPATH, COOKIE_DOMAIN, $secure_logged_in_cookie, true );
        }
//...

我们看到了在这个方法中设置了cookie
中间,我们看到cookie生成的实现方法如下

wp_generate_auth_cookie

我们进入此方法查看,代码不多

    function wp_generate_auth_cookie( $user_id, $expiration, $scheme = 'auth', $token = '' ) {
        $user = get_userdata( $user_id );
        if ( ! $user ) {
            return '';
        }

        if ( ! $token ) {
            $manager = WP_Session_Tokens::get_instance( $user_id );
            $token   = $manager->create( $expiration );
        }

        $pass_frag = substr( $user->user_pass, 8, 4 );

        $key = wp_hash( $user->user_login . '|' . $pass_frag . '|' . $expiration . '|' . $token, $scheme );

        // If ext/hash is not present, compat.php's hash_hmac() does not support sha256.
        $algo = function_exists( 'hash' ) ? 'sha256' : 'sha1';
        $hash = hash_hmac( $algo, $user->user_login . '|' . $expiration . '|' . $token, $key );

        $cookie = $user->user_login . '|' . $expiration . '|' . $token . '|' . $hash;

        /**
         * Filters the authentication cookie.
         *
         * @since 2.5.0
         * @since 4.0.0 The `$token` parameter was added.
         *
         * @param string $cookie     Authentication cookie.
         * @param int    $user_id    User ID.
         * @param int    $expiration The time the cookie expires as a UNIX timestamp.
         * @param string $scheme     Cookie scheme used. Accepts 'auth', 'secure_auth', or 'logged_in'.
         * @param string $token      User's session token used.
         */
        return apply_filters( 'auth_cookie', $cookie, $user_id, $expiration, $scheme, $token );
    }

很明显地看到,生成cookie的值之后,执行了过滤器‘auth_cookie’,也就是说,这个方法,wp是允许我们修改cookie的值的,我们可以定义自己的 cookie值。

小知识点
如果apply_filters 没有相关的add_filter,那么就会返回第一个值
这里 return apply_filters 就会返回第一个值 $cookie 做为apply_filters 最终的结果。

综上所述,如果我们想要添加我们自定义的token,只需要添加此过滤器并且返回我们自定义的cookie值即可。

上一篇下一篇

猜你喜欢

热点阅读