説明
パラメータ
バージョン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
関連
お勧め
Contact Form 7に確認フェーズを(2012年12月16日 更新)
Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。Somewhere search box:プラグイン作ってみました(2021年4月26日 更新)
投稿済みの記事を修正する際、毎回「投稿一覧」に戻るのは面倒だ、そんなことを感じて作ったのがこのプラグインです。また1.2.0では投稿内容(本文、カテゴリーや投稿タグ、カスタムフィールド)を複製するリンクを投稿一覧ページと投稿編集ページに追加、1.3.0では投稿タイトルのみの検索をサポートしました。カスタムブロックを作っていると、ブロック自身の「サイズ」を指定するUIを持たせることがある。そんなときにちょっとモヤっとするのが、「マージン」や「パディング」の設定しているパネルのタイトルが「サイズ」なこと。この「サイズ」の原文は「Dimensions」であり、個人的にもう少しスッキリするワードに変更してみた。
決まった値を返すだけの関数群(2018年5月27日 更新)
WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。
5.7の新機能:AJAXでパスワードを取得(2021年2月17日 更新)
日本時間の今朝「WordPress 5.7 Beta 3(以降Beta 3)」が予定通り公開されました。今回は、ソースコードを眺めていた時に気になったパスワードを取得できるAJAXについて確認した。