説明
パラメータ
バージョン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
関連
お勧め
投稿内容のid属性などを保存するための対策(2012年6月15日 更新)
WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった(id属性が保存できなくなった)。ここでは、その対策方法の1つを紹介しておく。WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)
今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。
4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)
従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。
Google Mapsブロックを作る過程で悩んだ件(2022年8月23日 更新)
自分なりのGoogle Mapsブロックを作るべく、カスタムHTMLブロックをベースにいくつかのパラメータ要素をサイドバーに追加していく。Google Maps用のAPIキーについてはオプションデータ(wp_optionsテーブル)に格納して利用していこうと思ったのだが、その方法がさっぱりわからなかった。
Popoverコンポーネントのanchorプロパティについて考えたときのメモ(2024年8月19日 更新)
カスタムブロックやコアブロック向けのプラグインでお世話になるPopoverコンポーネント。表示位置を決定する上で大きく影響するのがanchorプロパティである。フィルターのコールバック関数で対象ブロックに干渉できない場合はどうしたらよいのだろうか。