wp_signon

(2.5.0以降)
wp_signon - 認証処理を行う

説明

mixed wp_signon( [ array $credentials = array() [ , mixed $secure_cookie = '' ] ] )
認証処理を行う。

パラメータ

  • $credentials
    認証情報を連想配列で指定(省略時はarray())。連想配列の内容は次の通り。
    キーデータ型意味
    'user_login'stringログイン名
    'user_password'stringパスワード
    'remember'boolログイン情報を保持する場合はtrue
  • $secure_cookie
    セキュアクッキーを使用する場合はtrueを指定(省略時は'')。

返り値

認証できた場合はユーザー情報オブジェクトを返す。認証に失敗した場合はWP_Errorオブジェクトを返す。

注意

パラメータ$credentialsの省略時は$_POSTを参照するが、キー名が異なるので注意が必要である。

$credentialsのキー$_POSTのキー
'user_login''log'
'user_password''pwd'
'remember''rememberme'

パラメータ$secure_cookie省略時は、is_ssl関数の結果が適用される。

使用例

  • $_POSTパラメータで認証処理を行う。
    <?php wp_signon(); ?>
  • 連想配列を指定した$paramで認証処理を行う。
    <?php wp_signon( $param ); ?>

フィルター

[3.1.0]認証処理を行う(認証時のクッキーを出力する)前、'secure_signon_cookie'フィルターを実行する。パラメータ$secure_cookie$credentialsは省略時処理済みの値が格納されている。
$secure_cookie = apply_filters( 'secure_signon_cookie', $secure_cookie, $credentials );

アクション

[1.5.1]$credentialsの初期処理後、'wp_authenticate'アクションを実行する。パラメータは配列で、索引0の要素がログイン名のポインタ、索引1の要素がパスワードのポインタが格納されている。
do_action_ref_array( 'wp_authenticate', array( &$credentials['user_login'], &$credentials['user_password'] ) );
[1.5.0]認証したユーザー情報を返す前に'wp_login'を実行する。パラメータ$user_loginにはログイン名、$userにはユーザー情報オブジェクトが格納されている。
do_action( 'wp_login', $user_login, $user );

ソースファイル

/wp-includes/user.php

関連

  • is_ssl - リクエストがSSLかどうか調べる

お勧めコンテンツ

カスタムフィールドで並び替え(2013年8月9日 登録)

WordPressでは複数の投稿記事を取得する際、並び順の指定を省略すると投稿日時の降順になる。並び順は、投稿日時だけでなく、更新日時、投稿名、記事タイトル、コメント数のほか、カスタムフィールドも指定できる。

Blacklist keys manager:プラグイン作ってみました(2013年9月13日 登録)

少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。

3.6リリース直前チェック(2013年7月26日 登録)

$wpdbは、WordPressのデータベースにアクセスする際に使用できる便利なオブジェクト。独自テーブルの利用やデータ検索の最適化など、標準提供される関数では実現できないことを手助けしてくれる。そんな$wpdbのescapeメソッドが3.6で非推奨(deprecated)になる。

Widgets on dashboard:プラグイン作ってみました(2014年5月6日 登録)

サイトバーなどのページ構成パーツとしてウィジェットを利用し、ある程度頻繁に更新している場合、毎回ウィジェットページを表示するのはちょっとだけ面倒かも。そんなわけで、シンプルにダッシュボードで直接編集できればいいかなと思い、調べてみました。

パスとURL(2011年10月6日 登録)

テーマやプラグインで、WordPressシステム関連のディレクトリやURLを使う時があり、それらの多くは関数や定数として定義されている。今回は、それらの関数や定数について整理していく。

最終更新日時 : 2014-07-24 13:43