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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(和訳完了。)
 
1行目: 1行目:
{{NeedTrans}}
+
{{CheckTrans}}
  
 
== 説明<span id="Description"></span> ==
 
== 説明<span id="Description"></span> ==
  
Insert /Update a user into the database. For '''updating an existing user and sending a password change email''', use [[関数リファレンス/wp_update_user|<tt>wp_update_user()</tt>]] /[[:en:Function Reference/wp_update_user|en]] function instead.
+
ユーザーをデータベースへ登録または更新します。''登録済みユーザーを更新してパスワード変更通知メールを送る''には、関数 [[関数リファレンス/wp_update_user|<tt>wp_update_user()</tt>]] を代わりに使ってください。
  
 
== 使い方<span id="Usage"></span> ==
 
== 使い方<span id="Usage"></span> ==
11行目: 11行目:
 
== パラメータ<span id="Parameters"></span> ==
 
== パラメータ<span id="Parameters"></span> ==
  
{{Parameter|$userdata|mixed|An array of user data, stdClass or [[クラスリファレンス/WP_User|WP_User]] object.}}
+
{{Parameter|$userdata|mixed|ユーザー情報の配列、stdClass、[[クラスリファレンス/WP_User|WP_User]] オブジェクトのいずれか。}}
  
 
== 戻り値<span id="Return Values"></span> ==
 
== 戻り値<span id="Return Values"></span> ==
17行目: 17行目:
 
; <tt>(mixed)</tt> :
 
; <tt>(mixed)</tt> :
  
* If successful, returns the newly-created user's user_id
+
* 成功すると、新規登録したユーザーの ID を返します。
* If query fails returns a [[クラスリファレンス/WP_Error|WP_Error]] object
+
* クエリが失敗すると [[クラスリファレンス/WP_Error|WP_Error]] オブジェクトを返します。
* If user_login is longer than 60 characters, returns a [[クラスリファレンス/WP_Error|WP_Error]] object.
+
* user_login が60文字より長いと、[[クラスリファレンス/WP_Error|WP_Error]] オブジェクトを返します。
* If user_nicename is longer than 50 characters, returns a [[クラスリファレンス/WP_Error|WP_Error]] object.
+
* user_nicename が50文字より長いと、[[クラスリファレンス/WP_Error|WP_Error]] オブジェクトを返します。
  
 
== 用例<span id="Examples"></span> ==
 
== 用例<span id="Examples"></span> ==
  
Below is an example showing how to insert a new user with the website profile field filled.
+
次の例はプロフィールのウェブサイト項目を埋めて新しいユーザーを登録する方法を示します。
 +
 
 
<pre>
 
<pre>
 
<?php
 
<?php
32行目: 33行目:
 
     'user_login'  =>  'login_name',
 
     'user_login'  =>  'login_name',
 
     'user_url'    =>  $website,
 
     'user_url'    =>  $website,
     'user_pass'  =>  NULL  // When creating an user, `user_pass` is expected.
+
     'user_pass'  =>  NULL  // ユーザーを登録するとき、`user_pass` が必要。
 
);
 
);
  
 
$user_id = wp_insert_user( $userdata ) ;
 
$user_id = wp_insert_user( $userdata ) ;
  
//On success
+
// 成功した場合
 
if ( ! is_wp_error( $user_id ) ) {
 
if ( ! is_wp_error( $user_id ) ) {
     echo "User created : ". $user_id;
+
     echo "ユーザーを作成しました : ". $user_id;
 
}
 
}
  
51行目: 52行目:
 
この関数は内部で以下の関数を使います。
 
この関数は内部で以下の関数を使います。
  
* Uses: [[クラスリファレンス/wpdb|<tt>$wpdb</tt>]] WordPress database layer.
+
* [[クラスリファレンス/wpdb|<tt>$wpdb</tt>]] WordPress データベース抽象化レイヤー。
* Uses: [[関数リファレンス/apply_filters|<tt>apply_filters()</tt>]] Calls filters for most of the <tt>$userdata</tt> fields with the prefix 'pre_user'. See [[#Description|description above]].
+
* [[関数リファレンス/apply_filters|<tt>apply_filters()</tt>]] を使って <tt>$userdata</tt> のフィールドにフィルターを適用します。フィルター名はフィールド名に 'pre_user' を前置したものです。'''参考:''' [[#.E5.BC.95.E6.95.B0.E3.81.AE.E8.A9.B3.E7.B4.B0|引数の詳細]]を見てください。
* Uses: [[関数リファレンス/do_action|<tt>do_action()</tt>]] Calls 'profile_update' hook when updating giving the user's ID
+
* 更新の場合、[[関数リファレンス/do_action|<tt>do_action()</tt>]] を使って [https://developer.wordpress.org/reference/hooks/profile_update/ <tt>'profile_update'</tt>] フックを呼び出します。引数はユーザー ID と更新前のユーザー情報です。
* Uses: [[関数リファレンス/do_action|<tt>do_action()</tt>]] Calls 'user_register' hook when creating a new user giving the user's ID
+
* 登録の場合、[[関数リファレンス/do_action|<tt>do_action()</tt>]] を使って [https://developer.wordpress.org/reference/hooks/user_register/ <tt>'user_register'</tt>] フックを呼び出します。引数はユーザー ID です。
  
 
=== 引数の詳細 ===
 
=== 引数の詳細 ===
64行目: 65行目:
 
! style="font-weight:bold" | Field Name
 
! style="font-weight:bold" | Field Name
 
! Description
 
! Description
! [[プラグイン API/フィルターフック一覧#.E3.83.87.E3.83.BC.E3.82.BF.E3.83.99.E3.83.BC.E3.82.B9.E6.9B.B8.E3.81.8D.E8.BE.BC.E3.81.BF_4|Associated Filter]]
+
! [[プラグイン API/フィルターフック一覧#.E3.83.87.E3.83.BC.E3.82.BF.E3.83.99.E3.83.BC.E3.82.B9.E6.9B.B8.E3.81.8D.E8.BE.BC.E3.81.BF_4|対応するフィルター]]
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | ID
 
| style="font-weight:bold" | ID
| An integer that will be used for updating an existing user.
+
| 更新するユーザーの ID を表す整数。
| (none)
+
| (なし)
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | user_pass
 
| style="font-weight:bold" | user_pass
| A string that contains the plain text password for the user.
+
| ユーザーのプレーンテキスト形式のパスワードを表す文字列。<br />'''後の注記をみてください。'''
 
| <tt>pre_user_pass</tt>
 
| <tt>pre_user_pass</tt>
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | user_login
 
| style="font-weight:bold" | user_login
| A string that contains the user's username for logging in.
+
| ユーザーがログインするときのユーザー名を表す文字列。
 
| <tt>pre_user_login</tt>
 
| <tt>pre_user_login</tt>
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | user_nicename
 
| style="font-weight:bold" | user_nicename
| A string that contains a URL-friendly name for the user. The default is the user's username.
+
| URL に含めて安全なユーザー名を表す文字列。デフォルトは <tt>'user_login'</tt> の値。
 
| <tt>pre_user_nicename</tt>
 
| <tt>pre_user_nicename</tt>
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | user_url
 
| style="font-weight:bold" | user_url
| A string containing the user's URL for the user's web site.
+
| ユーザのウェブサイト URL を表す文字列。
 
| <tt>pre_user_url</tt>
 
| <tt>pre_user_url</tt>
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | user_email
 
| style="font-weight:bold" | user_email
| A string containing the user's email address.
+
| ユーザーのメールアドレスを表す文字列。
 
| <tt>pre_user_email</tt>
 
| <tt>pre_user_email</tt>
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | display_name
 
| style="font-weight:bold" | display_name
| A string that will be shown on the site. Defaults to user's username. It is likely that you will want to change this, for both appearance and security through obscurity (that is if you dont use and delete the default admin user).
+
| ユーザーを表すものとしてサイトに表示される文字列。デフォルトは <tt>'user_login'</tt> の値。視認性と開示によるセキュリティの両面から、変えたいと思うことが多いでしょう(例えばデフォルトの admin ユーザーを使わないが削除もしない場合)。
 
| <tt>pre_user_display_name</tt>
 
| <tt>pre_user_display_name</tt>
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | nickname
 
| style="font-weight:bold" | nickname
| The user's nickname, defaults to the user's username.
+
| ユーザーのニックネーム。デフォルトは <tt>'user_login'</tt> の値。
 
| <tt>pre_user_nickname</tt>
 
| <tt>pre_user_nickname</tt>
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | first_name
 
| style="font-weight:bold" | first_name
| The user's first name.
+
| ユーザーの名前(姓名の名)。
 
| <tt>pre_user_first_name</tt>
 
| <tt>pre_user_first_name</tt>
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | last_name
 
| style="font-weight:bold" | last_name
| The user's last name.
+
| ユーザーの姓。
 
| <tt>pre_user_last_name</tt>
 
| <tt>pre_user_last_name</tt>
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | description
 
| style="font-weight:bold" | description
| A string containing content about the user.
+
| ユーザーの「プロフィール情報」を表す文字列。
 
| <tt>pre_user_description</tt>
 
| <tt>pre_user_description</tt>
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | rich_editing
 
| style="font-weight:bold" | rich_editing
| A string for whether to enable the rich editor or not. False if not empty.
+
| ビジュアルリッチエディターを有効にするかどうかを表す文字列。空文字列なら有効。
 
| (none)
 
| (none)
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | user_registered
 
| style="font-weight:bold" | user_registered
| The date the user registered. Format is Y-m-d H:i:s.
+
| ユーザーを登録した日時。形式は <code>Y-m-d H:i:s</code> です。
 
| (none)
 
| (none)
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | role
 
| style="font-weight:bold" | role
| A string used to set the user's role.
+
| ユーザーの権限グループを表す文字列。
 
| (none)
 
| (none)
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | jabber
 
| style="font-weight:bold" | jabber
| User's Jabber account.
+
| ユーザーの Jabber アカウント。
 
| (none)
 
| (none)
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | aim
 
| style="font-weight:bold" | aim
| User's AOL IM account.
+
| ユーザーの AOL IM アカウント。
 
| (none)
 
| (none)
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | yim
 
| style="font-weight:bold" | yim
| User's Yahoo IM account.
+
| ユーザーの Yahoo IM アカウント。
 
| (none)
 
| (none)
 
|-valign="top"
 
|-valign="top"
 
| style="font-weight:bold" | locale
 
| style="font-weight:bold" | locale
| User's locale.
+
| ユーザーのロケール(言語)。
 
| (none)
 
| (none)
 
|}
 
|}
  
  
If there is no ID, a new user will be created.
+
'''注意:''' ID を指定しなければ、ユーザーが新規登録されます。
If ''' you pass an ID ''', the user with that ID will be updated, and these meta fields are updated if set in '''$userdata''' otherwise they are set to null:
+
'''ID を指定すると'''、その ID のユーザーが更新され、さらに以下のメタ情報が('''$userdata''' に指定されていれば)更新されるか、(指定がなければ)null がセットされます:
 
<pre>
 
<pre>
 
first_name,
 
first_name,
154行目: 155行目:
 
locale
 
locale
 
</pre>
 
</pre>
When performing an update operation using [[関数リファレンス/wp_insert_user|<tt>wp_insert_user()</tt>]], user_pass should be the hashed password and not the plain text password.
+
 
 +
'''注意:''' [[関数リファレンス/wp_insert_user|<tt>wp_insert_user()</tt>]] を使って''ユーザーを更新する''場合、user_pass はハッシュ化済みのパスワードを与える必要があります(プレーンテキストではなく)。
  
 
== 変更履歴<span id="Change_Log"></span> ==
 
== 変更履歴<span id="Change_Log"></span> ==
  
* [[Version_4.7|4.7.0]]: Now accepts 'locale' as $userdata's key
+
* [[Version_4.7|4.7.0]]: $userdata のキーに 'locale' を指定できるようになりました。
* [[Version_3.5|3.5.0]]: Now accepts stdClass or [[クラスリファレンス/WP_User|WP_User]] object
+
* [[Version_3.5|3.5.0]]: 引数として stdClass または [[クラスリファレンス/WP_User|WP_User]] オブジェクトも受け取れるようになりました。
* Since: 2.0.0
+
* 新規導入: 2.0.0
  
 
== ソースファイル<span id="Source_File"></span> ==
 
== ソースファイル<span id="Source_File"></span> ==
  
As of 3.1 <tt>wp_insert_user()</tt> is located in {{Trac|wp-includes/user.php}}.
+
<tt>wp_insert_user()</tt> {{Trac|wp-includes/user.php}} にあります。
  
 
== 関連項目<span id="Related"></span> ==
 
== 関連項目<span id="Related"></span> ==

2017年5月5日 (金) 18:28時点における最新版

この項目「関数リファレンス/wp insert user」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

説明

ユーザーをデータベースへ登録または更新します。登録済みユーザーを更新してパスワード変更通知メールを送るには、関数 wp_update_user() を代わりに使ってください。

使い方

<?php wp_insert_user( $userdata ); ?>

パラメータ

$userdata
mixed) (必須) ユーザー情報の配列、stdClass、WP_User オブジェクトのいずれか。
初期値: なし

戻り値

(mixed) 
  • 成功すると、新規登録したユーザーの ID を返します。
  • クエリが失敗すると WP_Error オブジェクトを返します。
  • user_login が60文字より長いと、WP_Error オブジェクトを返します。
  • user_nicename が50文字より長いと、WP_Error オブジェクトを返します。

用例

次の例はプロフィールのウェブサイト項目を埋めて新しいユーザーを登録する方法を示します。

<?php

$website = "http://example.com";
$userdata = array(
    'user_login'  =>  'login_name',
    'user_url'    =>  $website,
    'user_pass'   =>  NULL  // ユーザーを登録するとき、`user_pass` が必要。
);

$user_id = wp_insert_user( $userdata ) ;

// 成功した場合
if ( ! is_wp_error( $user_id ) ) {
    echo "ユーザーを作成しました : ". $user_id;
}

?>

参考

内部で使われる関数

この関数は内部で以下の関数を使います。

  • $wpdb WordPress データベース抽象化レイヤー。
  • apply_filters() を使って $userdata のフィールドにフィルターを適用します。フィルター名はフィールド名に 'pre_user' を前置したものです。参考: 引数の詳細を見てください。
  • 更新の場合、do_action() を使って 'profile_update' フックを呼び出します。引数はユーザー ID と更新前のユーザー情報です。
  • 登録の場合、do_action() を使って 'user_register' フックを呼び出します。引数はユーザー ID です。

引数の詳細

配列 $userdata には次の項目を含めることができます。

Field Name Description 対応するフィルター
ID 更新するユーザーの ID を表す整数。 (なし)
user_pass ユーザーのプレーンテキスト形式のパスワードを表す文字列。
後の注記をみてください。
pre_user_pass
user_login ユーザーがログインするときのユーザー名を表す文字列。 pre_user_login
user_nicename URL に含めて安全なユーザー名を表す文字列。デフォルトは 'user_login' の値。 pre_user_nicename
user_url ユーザのウェブサイト URL を表す文字列。 pre_user_url
user_email ユーザーのメールアドレスを表す文字列。 pre_user_email
display_name ユーザーを表すものとしてサイトに表示される文字列。デフォルトは 'user_login' の値。視認性と開示によるセキュリティの両面から、変えたいと思うことが多いでしょう(例えばデフォルトの admin ユーザーを使わないが削除もしない場合)。 pre_user_display_name
nickname ユーザーのニックネーム。デフォルトは 'user_login' の値。 pre_user_nickname
first_name ユーザーの名前(姓名の名)。 pre_user_first_name
last_name ユーザーの姓。 pre_user_last_name
description ユーザーの「プロフィール情報」を表す文字列。 pre_user_description
rich_editing ビジュアルリッチエディターを有効にするかどうかを表す文字列。空文字列なら有効。 (none)
user_registered ユーザーを登録した日時。形式は Y-m-d H:i:s です。 (none)
role ユーザーの権限グループを表す文字列。 (none)
jabber ユーザーの Jabber アカウント。 (none)
aim ユーザーの AOL IM アカウント。 (none)
yim ユーザーの Yahoo IM アカウント。 (none)
locale ユーザーのロケール(言語)。 (none)


注意: ID を指定しなければ、ユーザーが新規登録されます。 ID を指定すると、その ID のユーザーが更新され、さらに以下のメタ情報が($userdata に指定されていれば)更新されるか、(指定がなければ)null がセットされます:

first_name,
last_name, 
nickname,
description,
rich_editing,
comment_shortcuts,
admin_color,
use_ssl,
show_admin_bar_front,
locale

注意: wp_insert_user() を使ってユーザーを更新する場合、user_pass はハッシュ化済みのパスワードを与える必要があります(プレーンテキストではなく)。

変更履歴

  • 4.7.0: $userdata のキーに 'locale' を指定できるようになりました。
  • 3.5.0: 引数として stdClass または WP_User オブジェクトも受け取れるようになりました。
  • 新規導入: 2.0.0

ソースファイル

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

関連項目

wp_update_user(), wp_create_user()
ブログユーザー関数: add_user_to_blog(), add_new_user_to_blog(), remove_user_from_blog(), get_users_of_blog(), is_user_member_of_blog()


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


最新英語版: WordPress Codex » Function_Reference/wp_insert_user最新版との差分