• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(関連情報: wp_signon)
 
(同じ利用者による、間の1版が非表示)
1行目: 1行目:
<div id="Description">
+
== 説明<span id="Description"></span> ==
== 解説 ==
+
</div>
+
  
オプションとして渡される認証情報でユーザーを認証します。[[関数リファレンス/wp_login|wp_login]] /[[:en:Function_Reference/wp_login|en]] (現在非推奨)関数にとってかわるものです。
+
オプションとして渡される認証情報でユーザーを認証します。非推奨になった関数 [[関数リファレンス/wp_login|wp_login]] /[[:en:Function_Reference/wp_login|en]] の代わりです。
  
<div id="Usage">
+
== 使い方<span id="Usage"></span> ==
  
== 使用法 ==
+
<?php wp_signon( $credentials, $secure_cookie ) ?>
</div>
+
<pre>
+
&lt;?php wp_signon( $credentials, $secure_cookie ) ?&gt;
+
</pre>
+
  
<div id="Parameters">
+
== パラメータ<span id="Parameters"></span> ==
== パラメータ ==
+
</div>
+
  
{{Parameter|$credentials|array|サイン・インするためのユーザ情報|オプション}}
+
{{Parameter|$credentials|配列|サインインするためのユーザ情報|オプション}}
{{Parameter|$secure_cookie|boolean|セキュアなCookieを使用するかどうか|オプション}}
+
{{Parameter|$secure_cookie|真偽値|セキュアな Cookie を使用するかどうか。|オプション}}
  
'''注意点:''' $credentialsを渡さない場合、wp_signonは$_POST変数を利用します。
+
'''参考:''' $credentials を省略すると、wp_signon() は変数 [http://php.net/manual/ja/reserved.variables.post.php <tt>$_POST</tt>] を利用します(キーは  <tt>"log", "pwd"</tt> および <tt>"rememberme"</tt>)。
  
<div id="Return_Value">
+
== 戻り値<span id="Return_Values"></span> ==
== 戻り値 ==
+
</div>
+
  
; '''(object)''' : 失敗すればWP_Errorが、成功すればWP_Userがかえってきます。
+
; '''(オブジェクト)''' : 失敗すると <tt>[[クラスリファレンス/WP_Error|WP_Error]]</tt> を、成功すると <tt>[[クラスリファレンス/WP_User|WP_User]]</tt> を返します。
 +
 
 +
== 用例<span id="Examples"></span> ==
 +
 
 +
この関数とアクションはテーマの functions.php へ配置できます。
 +
フック after_setup_theme を使うとヘッダーとクッキーの送信前に実行できるので、ログインに必要なクッキーをセットすることができます。
  
<div id="Examples">
 
== 使用例 ==
 
</div>
 
 
<pre><nowiki>
 
<pre><nowiki>
$creds = array();
+
function custom_login() {
$creds['user_login'] = 'example';
+
$creds = array();
$creds['user_password'] = 'plaintextpw';
+
$creds['user_login'] = 'example';
$creds['remember'] = true;
+
$creds['user_password'] = 'plaintextpw';
$user = wp_signon( $creds, false );
+
$creds['remember'] = true;
if ( is_wp_error($user) )
+
$user = wp_signon( $creds, false );
  echo $user->get_error_message();
+
if ( is_wp_error($user) )
 +
echo $user->get_error_message();
 +
}
 +
// ヘッダーとクッキーの送信前にアクションを起動する。
 +
add_action( 'after_setup_theme', 'custom_login' );
 
</nowiki></pre>
 
</nowiki></pre>
  
<div id="Change_Log">
+
== 参考<span id="Notes"></span> ==
== 改訂履歴 ==
+
 
</div>
+
* この関数はヘッダーを送信します。そのためコンテンツが返されるより前に起動しなければなりません。
 +
* この関数は認証用クッキーをセットします。送信しない場合、ユーザーはログインしません。
 +
 
 +
== 変更履歴<span id="Change_Log"></span> ==
  
 
新規導入: 2.5.0
 
新規導入: 2.5.0
  
<div id="Source_File">
+
== ソースファイル<span id="Source_File"></span> ==
== ソースファイル ==
+
</div>
+
  
<tt>wp_signon()</tt>はwp-includes/user.phpにあります。
+
<tt>wp_signon()</tt> は {{Trac|wp-includes/user.php}} にあります。
  
<div id="Related">
+
== 関連項目<span id="Related"></span> ==
== 関連情報 ==
+
</div>
+
  
 +
{{Tag Footer}}
  
{{原文|Function Reference/wp_signon|83846}}<!--15:53, 11 March 2010‎ MonochromeNight 版 -->
+
{{原文|Function Reference/wp_signon|158791}} <!--11:48, 5 November 2016 Glutaminefree 版 -->
  
 +
{{DEFAULTSORT:Wp_signon}}
 
[[Category:関数]]
 
[[Category:関数]]
 +
 +
[[en:Function Reference/wp_signon]]
 +
[[it:Riferimento funzioni/wp_signon]]

2018年7月7日 (土) 22:34時点における最新版

説明

オプションとして渡される認証情報でユーザーを認証します。非推奨になった関数 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最新版との差分