関数リファレンス/wp signon

説明

オプションとして渡される認証情報でユーザーを認証します。非推奨になった関数 wp_login /en の代わりです。

使い方

<?php wp_signon( $credentials, $secure_cookie ) ?>

パラメータ

$credentials

（配列） （オプション） サインインするためのユーザ情報

初期値： なし

$secure_cookie

（真偽値） （オプション） セキュアな Cookie を使用するかどうか。

初期値： なし

参考: $credentials を省略すると、wp_signon() は変数 $_POST を利用します（キーは "log", "pwd" および "rememberme"）。

戻り値

(オブジェクト) 

失敗すると WP_Error を、成功すると WP_User を返します。

用例

この関数とアクションはテーマの functions.php へ配置できます。 フック after_setup_theme を使うとヘッダーとクッキーの送信前に実行できるので、ログインに必要なクッキーをセットすることができます。

function custom_login() {
	$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();
}
// ヘッダーとクッキーの送信前にアクションを起動する。
add_action( 'after_setup_theme', 'custom_login' );

参考

• この関数はヘッダーを送信します。そのためコンテンツが返されるより前に起動しなければなりません。
• この関数は認証用クッキーをセットします。送信しない場合、ユーザーはログインしません。

変更履歴

新規導入: 2.5.0

ソースファイル

wp_signon() は wp-includes/user.php にあります。

関連項目

関数リファレンス、テンプレートタグ目次もご覧ください。

最新英語版： WordPress Codex » Function Reference/wp_signon （最新版との差分）