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

最終更新 : 2013年06月03日 18:10

関連

参考

Code Reference: wp_set_auth_cookie

お勧め

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう（2011年12月8日 更新）

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

固定ページを投稿ページ用テンプレートファイル（single.php）で表示する（2013年7月31日 更新）

固定ページと投稿ページのデザインが共通の場合、同じ内容のsingle.phpとpage.phpを用意すれば事足りるが、デザインの修正時は二度手間になってしまう。そこで、固定ページをsingle.phpで表示するようにできないか考えてみた。

もうquery_postsは呼ばない（2011年9月27日 更新）

トップページやカテゴリーページで標準の条件に少し手を加えた投稿情報を表示するケースがある。そんな時、テンプレートファイルの先頭で query_posts関数を呼び出して投稿情報を再抽出していたのだが、フィルター処理をうまく使えばquery_posts関数を呼び出さなくても大丈夫みたいだ。

使っていないか確認しないとね！（2017年11月18日 更新）

2003年に誕生したWordPress。その歴史の中には、廃止予定（deprecated）となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここでは3.24.9.0現在、廃止予定となっている関数をまとめて紹介する。

ホームディレクトリから過去のファイルを削除する（2013年1月27日 更新）

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。