説明
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
関連
お勧め
プラグインのロード順を制御する（2014年6月9日 更新）
これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。
5.3の機能強化：カスタムフィールドキーの条件指定が使いやすくなる（2019年11月19日 更新）
5.3 RC4もリリースされ、正式リリースまであと1週間。5.3の変更点を確認していると、WP_Meta_Queryクラスが変更されていた。これは「Expanded meta key comparison operators in 5.3」で紹介されており、さまざまな条件指定が追加されていた。
HTML entities button：プラグイン作ってみました（2021年4月28日 更新）
以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字（HTMLエンティティ）を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。更新ボタンの横にスピナーを実装する（2019年5月14日 更新）
WordPressの管理画面ではAJAXを使って何らかの処理を行う際、数秒間の空き時間にアイコンがクルクル回る「スピナー」を表示しているところがある。今作っているプラグインでこの「スピナー」を使いたくなったので、実装方法を調べてみた。
「順序」をtextからnumberに変更してみた（2018年5月27日 更新）
固定ページの編集画面の「投稿の属性」ウィジェットには、ページの並び替えに使用できる「順序」のinput要素がある。この「順序」のinput要素はtype属性が'text'となっており、編集の際にIMEが有効になってしまう場合がある。ページの編集頻度が多くなると、その都度IMEをオフにするのがやや面倒になってくる。