説明
パラメータ
- $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年12月12日 更新)
今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。
the_date関数で投稿日を確実に表示する(2011年12月20日 更新)
投稿記事の投稿日時を表示する際、 the_date関数を使用することが多いだろう。このthe_date関数はphpのdate関数と同じパラメータを指定することで、好みの日時フォーマットで投稿日時を表示できるのだが、ある条件の場合に投稿日時を表示しない。最初にこの現象に遭遇したときは、ちょっと悩まされた。投稿内容に応じてwpautopを制御する(2013年8月13日 更新)
投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。
xmlrpc.phpへのアクセスについてちょっと考えた(2018年5月27日 更新)
少し前のことですが、こちらのサーバーを何度かダウンさせてしまったのですが、その原因はxmlrpc.phpへアクセスが集中したことによってサーバーが過負荷となってしまったというものでした。すぐにサーバー性能を上げることはできないため、xmlrpc.phpのアクセスを全部拒否するという暫定対応してしまいました。
メディアライブラリに絞り込み用の「投稿タグ」を追加する(2014年6月24日 更新)
この記事は、先月投稿したコラム「メディア(attachment)を拡張してより便利に活用する」の続編。メディアで「投稿タグ」を追加するだけで「メディアライブラリ」ページの投稿一覧の中には「タグ」カラムが追加されるが、今回はその「投稿タグ」で絞り込み検索に対応してみる。