- サイトデザイン工事中です。ご意見をお寄せください。
- 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細)
関数リファレンス/wp signon
提供:WordPress Codex 日本語版
< 関数リファレンス
オプションとして渡される認証情報でユーザーを認証します。wp_login関数にとってかわるものです。
使用法
<?php wp_signon( $credentials, $secure_cookie ) ?>
パラメータ
- $credentials
- (array) (optional) サイン・インするためのユーザ情報
- 初期値: なし
- $secure_cookie
- (boolean) (optional) セキュアなCookieを使用するかどうか
- 初期値: なし
注意点: $credentialsを渡さない場合、wp_signonは$_POST変数を利用します。
戻り値
- (object)
- 失敗すればWP_Errorが、成功すればWP_Userがかえってきます。
使用例
$creds = array(); $creds['user_login'] = 'example'; $creds['user_password'] = 'plaintextpw'; $creds['remember'] = true; $user = wp_signon( $creds, false ); if ( is_wp_error($user) ) echo $user->get_error_message();
改訂履歴
Since: 2.5.0
ソースファイル
wp_signon()はwp-includes/user.phpにあります。