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

関連

  • is_ssl - リクエストがSSLかどうか調べる
  • wp_set_password - ログインパスワードを設定する

お勧めコンテンツ

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

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

絵文字画像がPNGからSVGへ(2016年8月15日 登録)

WordPressでは絵文字に対応していないブラウザ環境で絵文字を表示する仕組みをバージョン4.2から提供。絵文字に対応しているブラウザとそん色がない表示を実現する。

Post-tag automaton:プラグイン作ってみました(2012年7月3日 登録)

みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。

カレンダーウィジェットをAjaxで切り替える(2011年8月22日 登録)

ウィジェットベースでテーマを構築していてカレンダーを表示してみた。標準では、前月や次月のリンク先はそれぞれの月のアーカイブページとなっているのだが、記事を探すだけであればカレンダー部分だけを更新するほうが便利なのではと考え、そのアイデアを実装してみた。

ダッシュボードの「概要」にカスタム投稿タイプ件数を表示する(2013年12月17日 登録)

管理者向けページが刷新したWordPress 3.8。そのダッシュボードページにはサイトの状況を示す「概要(At a Glance)」ウィジェットがある。この中には「投稿」や「固定ページ」の投稿件数が表示されており、同じようにカスタム投稿タイプの投稿件数を表示できないか調べてみた。

最終更新日時 : 2013-06-03 18:10