説明
パラメータ
- $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
関連
お勧め
6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)
バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。
固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)
固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)
本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。
Fotepo:プラグイン作ってみました(2019年9月19日 更新)
仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。
カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)
サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。