説明
パラメータ
- $userdataユーザ情報を格納した連想配列またはオブジェクトを指定。指定できるユーザ情報の内容は次の通り。
プロパティ 意味 格納先 省略時の値 'ID' ユーザID wp_users 省略可 'user_login' ログイン名 wp_users 省略不可 'user_pass' パスワード wp_users 省略不可 'user_email' メールアドレス wp_users 省略時は'' 'user_url' URL wp_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 );
$user_nicename = apply_filters( 'pre_user_nicename', $user_nicename );
$user_url = apply_filters( 'pre_user_url', $user_url );
$user_email = apply_filters( 'pre_user_email', $user_email );
$nickname = apply_filters( 'pre_user_nickname', $nickname );
$first_name = apply_filters( 'pre_user_first_name', $first_name );
$last_name = apply_filters( 'pre_user_last_name', $last_name );
$display_name = apply_filters( 'pre_user_display_name', $display_name );
$description = apply_filters( 'pre_user_description', $description );
$data = apply_filters( 'wp_pre_insert_user_data', $data, $update, $id );
$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 );
do_action( 'user_register', $user_id );
ソースファイル
/wp-includes/user.php最終更新 : 2019年05月29日 15:35
関連
お勧め
投稿一覧ページに「更新日時」カラムを追加してみた(2019年8月27日 更新)
サイトの特性によるが、「投稿」には繰り返し更新するものがある。そんなサイトでは投稿一覧ページに「更新日時」があった方が便利。というわけで、今回は投稿一覧にソートに対応した「更新日時」カラムを追加する方法を紹介する。
連番のユーザーIDを回避できないか考えた(2019年6月4日 更新)
WordPressのユーザーIDは最初の管理者が1、次に追加したユーザーが2といった感じの連番になる。連番のIDはサイトによっては好ましくないケースがあり、連番を回避する方法がないか検討した。
Twenty Seventeenのフォントサイズを変更してみた(2021年12月15日 更新)
先日投稿した「続テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Seventeen」でもWebフォントを使えるようにした。その際、「Twenty Seventeen」のフォントサイズが少し小さく感じたので、今回はフォントサイズを調整してみた。
4.2.3でちょっと変わったショートコード(2018年5月27日 更新)
4.3のリリースまであと少しなわけですが、4.2.3が緊急リリースされました。4.2.2とソースコードを比較すると、ざっくりTinyMCE絡みが多い印象を受けたのですが、ショートコード関連も少し変わっていたので簡単にまとめてみました。
「投稿に挿入」時のタグをちょっとカスタマイズ(2011年7月29日 更新)
投稿画面において、画像をアップロードし投稿に挿入するすると、imgタグをaタグで囲んだものが挿入される(キャプションを指定した場合はタグも)。それらの画像をLightBox(JavaScriptライブラリ)で表示する場合、aタグにrel属性を追加するのだが、その作業を毎回投稿に挿入した後で行うのがちょっと面倒。というわけで、自動的にrel属性を追加するようにしてみました。