wp_insert_user

説明

mixed wp_insert_user( mixed $userdata )
ユーザーを登録する。

パラメータ

  • $userdata
    ユーザ情報を格納した連想配列またはオブジェクトを指定。指定できるユーザ情報の内容は次の通り。
    プロパティ意味格納先省略時の値
    'ID'ユーザIDwp_users省略可
    'user_login'ログイン名wp_users省略不可
    'user_pass'パスワードwp_users省略不可
    'user_email'メールアドレスwp_users省略時は''
    'user_url'URLwp_users省略時は''
    'user_nicename'URLに含められる名前wp_users省略時は'user_login'の値
    'display_name'表示名wp_users省略時は名前に関連する値から
    'user_registered'登録日時(書式は'Y-m-d H:i:s')wp_users現在のGMT日時
    'nickname'ニックネームwp_usermeta省略時は'user_login'の値
    'first_name'ファーストネームwp_usermeta省略時は''
    'last_name'ラストネームwp_usermeta省略時は''
    'description'説明wp_usermeta省略時は''
    'rich_editing'リッチエディタ使用wp_usermeta省略時は'true'
    'comment_shortcuts'コメントショートカットwp_usermeta省略時は'false'
    'admin_color'管理画面カラーwp_usermeta省略時は'fresh'
    'use_ssl'SSL使用wp_usermeta省略時は0
    'show_admin_bar_front'管理バー表示wp_usermeta省略時は'true'
    'role'ロールwp_usermeta省略時は get_option( 'default_role' )の値(登録時のみ)
    'locale'ロケールwp_usermeta省略時は''
    'jabber'Jabberアカウントwp_usermeta
    'aim'AOL IMアカウントwp_usermeta
    'yim'Yahoo IMアカウントwp_usermeta

※[3.6.0]'jabber'、'aim'、'yim'を削除。


返り値

ユーザ情報を登録・更新できた場合はそのユーザIDを返す。登録・更新できなかった場合は、そのエラー内容を格納した WP_Errorオブジェクトを返す。

注意

パラメータ$userdataが'ID'プロパティを持つ場合は、そのユーザIDの示すユーザ情報を更新する。'ID'プロパティを持たない場合は、新規に登録する。

ユーザ情報の新規登録時、キー'user_pass'の内容はプレーンテキストを指定する。

ユーザ情報の更新時にパスワードを変更する場合、キー'user_pass'の内容はプレーンテキストではなく、 wp_hash_password関数で生成したハッシュを指定する。


使用例

  • ユーザを登録する。
    <?php wp_insert_user( $userdata ); ?>

フィルター

登録・更新前に'pre_user_login'フィルターを呼び出す。
$user_login = apply_filters( 'pre_user_login', $user_login );
登録・更新前に'pre_user_nicename'フィルターを呼び出す。
$user_nicename = apply_filters( 'pre_user_nicename', $user_nicename );
登録・更新前に'pre_user_url'フィルターを呼び出す。
$user_url = apply_filters( 'pre_user_url', $user_url );
登録・更新前に'pre_user_email'フィルターを呼び出す。
$user_email = apply_filters( 'pre_user_email', $user_email );
登録・更新前に'pre_user_nickname'フィルターを呼び出す。
$nickname = apply_filters( 'pre_user_nickname', $nickname );
登録・更新前に'pre_user_first_name'フィルターを呼び出す。
$first_name = apply_filters( 'pre_user_first_name', $first_name );
登録・更新前に'pre_user_last_name'フィルターを呼び出す。
$last_name = apply_filters( 'pre_user_last_name', $last_name );
登録・更新前に'pre_user_display_name'フィルターを呼び出す。
$display_name = apply_filters( 'pre_user_display_name', $display_name );
登録・更新前に'pre_user_description'フィルターを呼び出す。
$description = apply_filters( 'pre_user_description', $description );
[4.9.0]ユーザ情報の追加または更新を行う前に'wp_pre_insert_user_data'フィルターを呼び出す。パラメータ$dataにはユーザ情報の連想配列が、$updateには更新時はtrue、追加時にはfalseが、$idは更新時ならユーザID、追加時はnullが格納されている。
$data = apply_filters( 'wp_pre_insert_user_data', $data, $update, $id );
[4.4.0]ユーザのメタ情報(ニックネームなど)を更新する前に'insert_user_meta'フィルターを呼び出す。パラメータ$dataにはメタ情報の連想配列が、$userにはユーザ情報(オブジェクト)が、$updateには更新時はtrue、追加時にはfalseが格納されている。
$meta = apply_filters( 'insert_user_meta', $meta, $user, $update );

アクション

ユーザ情報を更新した後に'profile_update'アクションを呼び出す。$user_idには更新したユーザIDが、$old_user_dataには更新前のユーザ情報が格納される。
do_action( 'profile_update', $user_id, $old_user_data );
ユーザ情報を渡鹿した後に'user_register'アクションを呼び出す。$user_idには登録したユーザIDが格納される。
do_action( 'user_register', $user_id );

ソースファイル

/wp-includes/user.php

最終更新 : 2019年05月29日 15:35



お勧め

自動生成される抜粋からテーブルブロックの内容を除外する(2022年4月6日 更新)

標準テーマである「Twenty Twenty-Two」や「Twenty Twenty-One」では、トップページやアーカイブページにおいて投稿情報を表示する際、その抜粋を使っている。とある投稿にテーブルブロックを入れた際、トップページに表示された抜粋には各セルの内容が列挙され、ちょっとモヤモヤした。

Post-tag automaton:プラグイン作ってみました(2012年12月24日 更新)

みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。

ダッシュボードのフィードボックスをカスタマイズ(2011年7月8日 更新)

管理者ページのトップページ「ダッシュボード」には、「WordPress 開発者ブログ」と「WordPress フォーラム」という2つのフィードボックスが表示されている。自分のような開発者には有益な情報をもたらしているが、一般の方には必要のない情報かもしれない。今回はこのフィードボックスをカスタマイズする方法を紹介する(管理者権限)。

投稿一覧に「投稿フォーマット」フィルターが追加される(2019年4月12日 更新)

WordPress 5.2 Beta2(以降5.2Beta2)のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」(select要素)が追加されていた。

さくらのVPSでKUSANAGI#2(2018年5月27日 更新)

今回は「前回」の続き。さくらのVPS(メモリー2GB SSDプラン)でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。