説明
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
関連
お勧め
投稿一覧ページに「更新日時」カラムを追加してみた（2019年8月27日 更新）
サイトの特性によるが、「投稿」には繰り返し更新するものがある。そんなサイトでは投稿一覧ページに「更新日時」があった方が便利。というわけで、今回は投稿一覧にソートに対応した「更新日時」カラムを追加する方法を紹介する。
連番のユーザーIDを回避できないか考えた（2019年6月4日 更新）
WordPressのユーザーIDは最初の管理者が1、次に追加したユーザーが2といった感じの連番になる。連番のIDはサイトによっては好ましくないケースがあり、連番を回避する方法がないか検討した。
Twenty Seventeenのフォントサイズを変更してみた（2021年12月15日 更新）
先日投稿した「続テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Seventeen」でもWebフォントを使えるようにした。その際、「Twenty Seventeen」のフォントサイズが少し小さく感じたので、今回はフォントサイズを調整してみた。
4.2.3でちょっと変わったショートコード（2018年5月27日 更新）
4.3のリリースまであと少しなわけですが、4.2.3が緊急リリースされました。4.2.2とソースコードを比較すると、ざっくりTinyMCE絡みが多い印象を受けたのですが、ショートコード関連も少し変わっていたので簡単にまとめてみました。
「投稿に挿入」時のタグをちょっとカスタマイズ（2011年7月29日 更新）
投稿画面において、画像をアップロードし投稿に挿入するすると、imgタグをaタグで囲んだものが挿入される（キャプションを指定した場合はタグも）。それらの画像をLightBox（JavaScriptライブラリ）で表示する場合、aタグにrel属性を追加するのだが、その作業を毎回投稿に挿入した後で行うのがちょっと面倒。というわけで、自動的にrel属性を追加するようにしてみました。