説明
パラメータ
バージョン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
関連
お勧め
Slightly troublesome permalink:プラグイン作ってみました(2021年4月20日 更新)
カテゴリーを含んだパーマリンクを設定している場合、複数のカテゴリーを指定した投稿記事のパーマリンクのURLに目的のカテゴリーとは異なるカテゴリーが適用された経験はないだろうか。このプラグインは、パーマリンクに適用されるカテゴリーをコントロールし、希望通りのパーマリンクを設定します。Gutenberg、初見です(2018年8月6日 更新)
先週末、WordPress 4.9.8がリリースされ、事前に告知されてたように「Gutenberg」がお披露目になった。投稿編集ページがガラリと変わり、影響範囲はそれなりに大きいと思われる。まずはこの週末に感じたことを整理してみた。
初期状態で「抜粋」ウィジェットを表示する(2014年1月7日 更新)
投稿編集ページのウィジェットは標準で表示されるものとされないものがある。フォーラムに『投稿の編集画面にデフォルトで抜粋を表示させたい』という投稿があったので、ちょっと調べてみた。
使っていないか確認しないとね!(フィルター編)(2019年4月24日 更新)
先週末にWordPress 5.2 Beta3(以降5.2Beta3)が公開され、正式リリースまであとわずか。ソースコードの変更点を見ていくと、wp-login.phpの中に非推奨となったフィルターが目に留まった。
Login rebuilder 2.6.0の新機能紹介(2019年4月22日 更新)
今回追加したものは、REST API / Usersの使用をログイン時のみ使用できるように制限する機能である。この機能を有効にすることで、管理者情報が漏洩するリスクを低減させる効果が期待できる。