- 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。（詳細）
「関数リファレンス/get user by」の版間の差分
提供: WordPress Codex 日本語版
< 関数リファレンス
(英語版をコピペ。) |
(和訳完了。) |
||
| 2行目: | 2行目: | ||
== 説明 == | == 説明 == | ||
</div> | </div> | ||
| − | + | <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>', | + | {{Parameter|$field|string|'<tt>id</tt>', '<tt>slug</tt>', '<tt>email</tt>', '<tt>login</tt>' のいづれか。}} |
| − | {{Parameter|$value|string | + | {{Parameter|$value|string / integer|この値を検索します。}} |
<div id="Return Values"> | <div id="Return Values"> | ||
== 戻り値 == | == 戻り値 == | ||
</div> | </div> | ||
| − | ; (mixed) : <tt>[[Class_Reference/WP_User | WP_User]]</tt> | + | ; (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> | ||
| − | * | + | * <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]] | + | * [[Version 3.3|3.3.0]] にて、<tt>[[Class_Reference/wpdb | wpdb]]</tt> の代わりに <tt>[[Class_Reference/WP_User | WP_User::get_data_by()]]</tt> を用いるように変更されました。 |
| − | * | + | * [[Version 2.8|2.8.0]] にて導入。 |
<div id="Source File"> | <div id="Source File"> | ||
== ソースファイル == | == ソースファイル == | ||
</div> | </div> | ||
| − | <tt>get_user_by()</tt> | + | <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;
注意点
- WP_User::get_data_by() を使用します。
改訂履歴
- 3.3.0 にて、 wpdb の代わりに WP_User::get_data_by() を用いるように変更されました。
- 2.8.0 にて導入。
ソースファイル
get_user_by() は wp-includes/pluggable.php にあります。
関連項目
最新英語版： WordPress Codex » Function Reference/get user by （最新版との差分）
関数リファレンス、テンプレートタグ目次もご覧ください。
