説明
パラメータ
バージョン4.3.1~
- $user_idユーザIDを指定。
- $deprecated未使用(省略時はnull)。
- $notify通知方法として'admin'、'both'([4.6.0]'user'が追加)を指定(省略時は'')。
バージョン4.3.0
- $user_idユーザIDを指定。
- $notify通知方法として'admin'、'both'を指定(省略時は'')。
バージョン2.0.0~4.2.x
- $user_idユーザIDを指定。
- $plaintext_passパスワードを指定。
返り値
返り値はありません。注意
ユーザ登録を管理者とそのユーザに通知する。バージョンにより通知内容・方法が異なり、4.6.0以降では管理者のみ('admin'または'')、ユーザのみ('user')、両者('both')の選択が可能になっている。
[4.3.0]新規ユーザへの通知内容に対してパスワードの記載を止めたことに伴い、wp-login.phpで呼び出されていた'retrieve_password_key'アクションを呼ぶようになった。
[4.9.0]追加された'wp_new_user_notification_email_admin'フィルターにより、プラグインなどによりメール内容が変更可能になった。このフィルターの第1パラメータの連想配列は次の内容となる。
キー | 内容 |
---|---|
'to' | サイト管理者のメールアドレス |
'subject' | メールタイトル(既定値は'[%s] New User Registration'を翻訳したもの) |
'message' | 通知メールの文面(バージョンによって異なる) |
'headers' | メールのヘッダー情報(既定値は'') |
[4.9.0]追加された'wp_new_user_notification_email'フィルターにより、プラグインなどによりメール内容が変更可能になった。このフィルターの第1パラメータの連想配列は次の内容となる。
キー | 内容 |
---|---|
'to' | 登録されたユーザのメールアドレス |
'subject' | メールタイトル(既定値は'[%s] Your username and password info'を翻訳したもの) |
'message' | 通知メールの文面(バージョンによって異なる) |
'headers' | メールのヘッダー情報(既定値は'') |
[6.1.0]'wp_send_new_user_notification_to_admin'フィルターが追加され、管理者向けに通知しない場合はこのフィルターのコールバック関数でtrue以外を返すことで制御できる。
'wp_send_new_user_notification_to_user'フィルターが追加され、ユーザーに通知しない場合はこのフィルターのコールバック関数でtrue以外を返すことで制御できる。
使用例
- ユーザが登録されたことを管理者に通知する。<?php wp_new_user_notification( $user_id ); ?>
- ユーザが登録されたことをユーザのみに通知する。<?php wp_new_user_notification( $user_id, null, 'user' ); ?>
フィルター
[6.1.0]管理者に通知メールを送信するか判定するために'wp_send_new_user_notification_to_admin'フィルターを呼び出す。パラメータ$sendの初期値にはtrueが、$userにはユーザ情報(WP_Userオブジェクト)が格納されている。$send_notification_to_admin = apply_filters( 'wp_send_new_user_notification_to_admin', $send, $user );
$wp_new_user_notification_email_admin = apply_filters( 'wp_new_user_notification_email_admin', $wp_new_user_notification_email_admin, $user, $blogname );
$send_notification_to_user = apply_filters( 'wp_send_new_user_notification_to_user', $send, $user );
$wp_new_user_notification_email = apply_filters( 'wp_new_user_notification_email', $wp_new_user_notification_email, $user, $blogname );
アクション
[4.3.0]ユーザに登録通知をする際に'retrieve_password_key'アクションを呼び出す。パラメータ$user_loginにはユーザのログイン名が、$keyには仮パスワードが格納されている。do_action( 'retrieve_password_key', $user_login, $key );
ソースファイル
/wp-includes/pluggable.php最終更新 : 2022年11月07日 16:46
関連
お勧め
ブロックエディターの色設定を変えてみる(2019年12月11日 更新)
バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。
「姓」の後に「名」を(2013年11月6日 更新)
WordPressのユーザー情報設定ページでは、「名(First name)」の後に「姓(Last name)」を入力するようになっている。日本向けのユーザー登録できるサイトの場合、この並び順はちょっと違和感があるので、「姓」「名」の順に入力できるようにした。
ホームディレクトリから過去のファイルを削除する(2013年1月27日 更新)
WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。Login rebuilder 2.6.5の新機能紹介(2021年3月8日 更新)
今回追加したものは、管理者のダッシュボードに表示されるログウィジェットの日時について任意の書式を設定する機能である。これまで日時の書式はサイト設定を利用していたが、ログの日時については揃えた方が見やすいと思ったので、今回の機能で対応することにしました。
投稿情報を連想配列で参照する(2018年5月27日 更新)
投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。