「関数リファレンス/wp signon」の版間の差分

2015年7月8日 (水) 09:23時点における版

オプションとして渡される認証情報でユーザーを認証します。wp_login /en （現在非推奨）関数にとってかわるものです。

<?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にあります。