説明
パラメータ
バージョン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
関連
お勧め
5.5で非推奨になる関数名について(2020年8月12日 更新)
来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2(以降Beta 2)」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。
meta_compare_key使ってみた(2019年3月19日 更新)
ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。
プラグインの設定ページもレスポンシブ対応(2014年6月3日 更新)
レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。
初期化に関連するアクションのおさらい(2013年11月27日 更新)
いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。全投稿を取得するのはnopaging=1でいい(2011年8月31日 更新)
query_posts関数(またはWP_Queryクラス)を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」-「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには?