説明
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'] ) );do_action( 'wp_login', $user_login, $user );ソースファイル
/wp-includes/user.php最終更新 : 2014年07月24日 13:43
関連
お勧め
個人データのエクスポートメール向けに追加された新フィルター（2020年4月2日 更新）
先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。
決まった値を返すだけの関数群（2018年5月27日 更新）
WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。
サイドバーの初期化はwidgets_initアクションで（2011年7月14日 更新）
ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。Gutenbergでカスタムフィールドを使う（2018年8月10日 更新）
Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。
favicon.icoがWordPressロゴになる！？（2020年2月25日 更新）
先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。