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

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

関数リファレンス/wp insert user

提供: WordPress Codex 日本語版
移動先: 案内検索

この項目「関数リファレンス/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最新版との差分