wp_set_auth_cookie:WordPress私的マニュアル

wp_set_auth_cookie

(2.5以降)
wp_set_auth_cookie - ログインIDをクッキーに保存する

説明

void wp_set_auth_cookie( int $user_id [ , bool $remember = false [ , mixed $secure = '' ] ] )

ログインIDをクッキーに保存する。

パラメータ

$user_id
ユーザIDを指定。
$remember
ブラウザが閉じた後もクッキーを保持する場合はtrue、保持しない場合はfalseを指定（省略時はfalse）。
$secure
セキュア時はtrueを指定（省略時は''）。

返り値

返り値はありません。

注意

パラメータ$rememberがtrueの場合、デフォルトのクッキーの有効期間は14日間となる。

使用例

ログインIDをクッキーに保存する。
<?php wp_set_auth_cookie( $user_id ); ?>
ブラウザが閉じた後もログインIDをクッキーに保存する。
<?php wp_set_auth_cookie( $user_id, true ); ?>

フィルター

始めに有効期間を'auth_cookie_expiration'フィルターを呼び出す。

/* $rememberがtrueの場合 */
$expiration = $expire = time() + apply_filters( 'auth_cookie_expiration', 1209600, $user_id, $remember );
/* $rememberがfalseの場合 */
$expiration = time() + apply_filters( 'auth_cookie_expiration', 172800, $user_id, $remember );

セキュア判定（いくつかのsetcookie関数の第6パラメータ）を確定するため、'secure_auth_cookie'フィルターを呼び出す。

$secure = apply_filters( 'secure_auth_cookie', $secure, $user_id );

ログイン済情報のセキュア判定（いくつかのsetcookie関数の第6パラメータ）を確定するため、'secure_logged_in_cookie'フィルターを呼び出す。

$secure_logged_in_cookie = apply_filters( 'secure_logged_in_cookie', false, $user_id, $secure );

アクション

クッキーを保存する前に'set_auth_cookie'アクションを実行する。

do_action( 'set_auth_cookie', $auth_cookie, $expire, $expiration, $user_id, $scheme );

クッキーを保存する前に'set_logged_in_cookie'アクションを実行する。

do_action( 'set_logged_in_cookie', $logged_in_cookie, $expire, $expiration, $user_id, 'logged_in' );

ソースファイル

/wp-includes/pluggable.php

参考

Code Reference: wp_set_auth_cookie