当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

「関数リファレンス/get user by」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(英語版をコピペ。)
 
(和訳完了。)
2行目: 2行目:
 
== 説明 ==
 
== 説明 ==
 
</div>
 
</div>
Get <tt>user</tt> data by field and data. The possible fields are shown below with the corresponding columns in the <tt>[[Database_Description#Table:_wp_users|wp_users]]</tt> database table.
+
<tt>user</tt> データのフィールドとデータを取得する関数です。ここで得られるフィールドは、<tt>[[Database_Description#Table:_wp_users|wp_users]]</tt> データベーステーブル内の関連するコラムと共に、以下に示します。
  
 
* '<tt>id</tt>' - ID
 
* '<tt>id</tt>' - ID
17行目: 17行目:
 
== パラメータ ==
 
== パラメータ ==
 
</div>
 
</div>
{{Parameter|$field|string|'<tt>id</tt>', '<tt>slug</tt>', '<tt>email</tt>', or '<tt>login</tt>'}}
+
{{Parameter|$field|string|'<tt>id</tt>', '<tt>slug</tt>', '<tt>email</tt>', '<tt>login</tt>' のいづれか。}}
{{Parameter|$value|string&#124;integer|Search for this field value}}
+
{{Parameter|$value|string / integer|この値を検索します。}}
  
 
<div id="Return Values">
 
<div id="Return Values">
 
== 戻り値 ==
 
== 戻り値 ==
 
</div>
 
</div>
; (mixed) : <tt>[[Class_Reference/WP_User | WP_User]]</tt> object or <tt>false</tt> if no user is found. Will also return <tt>false</tt> if <tt>$field</tt> does not exist.
+
; (mixed) : <tt>[[Class_Reference/WP_User | WP_User]]</tt> オブジェクト。ユーザーが見つからない場合は <tt>false</tt><tt>$field</tt> が存在しない場合も <tt>false</tt>
  
 
<div id="Example">
 
<div id="Example">
39行目: 39行目:
 
== 注意点 ==
 
== 注意点 ==
 
</div>
 
</div>
* Uses <tt>[[Class_Reference/WP_User | WP_User::get_data_by()]]</tt>.
+
* <tt>[[Class_Reference/WP_User | WP_User::get_data_by()]]</tt> を使用します。
  
 
<div id="Change Log">
 
<div id="Change Log">
 
== 改訂履歴 ==
 
== 改訂履歴 ==
 
</div>
 
</div>
* [[Version 3.3|3.3.0]] - This function now uses <tt>[[Class_Reference/WP_User | WP_User::get_data_by()]]</tt> instead of using <tt>[[Class_Reference/wpdb | wpdb]]</tt> directly.
+
* [[Version 3.3|3.3.0]] にて、<tt>[[Class_Reference/wpdb | wpdb]]</tt> の代わりに <tt>[[Class_Reference/WP_User | WP_User::get_data_by()]]</tt> を用いるように変更されました。
* Since: [[Version 2.8|2.8.0]]
+
* [[Version 2.8|2.8.0]] にて導入。
  
 
<div id="Source File">
 
<div id="Source File">
 
== ソースファイル ==
 
== ソースファイル ==
 
</div>
 
</div>
<tt>get_user_by()</tt> is located in {{Trac|wp-includes/pluggable.php}}.
+
<tt>get_user_by()</tt> {{Trac|wp-includes/pluggable.php}} にあります。
  
 
<div id="Related">
 
<div id="Related">

2013年8月10日 (土) 14:37時点における版

user データのフィールドとデータを取得する関数です。ここで得られるフィールドは、wp_users データベーステーブル内の関連するコラムと共に、以下に示します。

  • 'id' - ID
  • 'slug' - user_nicename
  • 'email' - user_email
  • 'login' - user_login

使い方

<?php $user = get_user_by( $field, $value ); ?>

パラメータ

$field
string) (必須) 'id', 'slug', 'email', 'login' のいづれか。
初期値: なし
$value
string / integer) (必須) この値を検索します。
初期値: なし

戻り値

(mixed) 
WP_User オブジェクト。ユーザーが見つからない場合は false$field が存在しない場合も false

用例

デフォルトの使い方

$user = get_user_by( 'email', 'user@example.com' );
echo 'User is ' . $user->first_name . ' ' . $user->last_name;

注意点

改訂履歴

ソースファイル

get_user_by()wp-includes/pluggable.php にあります。

get_userdata()


最新英語版: WordPress Codex » Function Reference/get user by 最新版との差分


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