wp_new_user_notification

（2.0.0以降）
wp_new_user_notification - ユーザが登録されたことを管理者とユーザに通知する

説明

void wp_new_user_notification( int $user_id [ , string ~~$plaintext_pass~~ $deprecated = null [ , string $notify = '' ] ] )

ユーザが登録されたことを管理者とユーザに通知する。

パラメータ

バージョン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 );

[4.9.0]管理者に通知メールを送信する前に'wp_new_user_notification_email_admin'フィルターを呼び出す。パラメータ$wp_new_user_notification_email_adminにはメール内容を示す連想配列が、$userにはユーザ情報（WP_Userオブジェクト）が、$blognameにはデコード済みのブログ名が格納されている。

$wp_new_user_notification_email_admin = apply_filters( 'wp_new_user_notification_email_admin', $wp_new_user_notification_email_admin, $user, $blogname );

[6.1.0]ユーザに通知メールを送信するか判定するために'wp_send_new_user_notification_to_user'フィルターを呼び出す。パラメータ$sendの初期値にはtrueが、$userにはユーザ情報（WP_Userオブジェクト）が格納されている。

$send_notification_to_user = apply_filters( 'wp_send_new_user_notification_to_user', $send, $user );

[4.9.0]ユーザに通知メールを送信する前に'wp_new_user_notification_email'フィルターを呼び出す。パラメータ$wp_new_user_notification_emailにはメール内容を示す連想配列が、$userにはユーザ情報（WP_Userオブジェクト）が、$blognameにはデコード済みのブログ名が格納されている。

$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

参考

Code Reference: wp_new_user_notification

お勧め

投稿情報を連想配列で参照する（2018年5月27日更新）

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。

WordPressのコーディングスタンダードとPSR-2がかみ合わない（2018年5月27日更新）

先日パソコンのストレージを換装して開発環境を再構築。エディタのEclipseは「Neon（4.6）」から「Oxygen（4.7）」へ切り替わった。コードを書き始めるとそこはかとなく違和感があり、調べていくとPHPの「Code Style（Formatter）」が「PSR-2」に設定されていることが原因だった。

続テーマを変更せずにWebフォントを使ってみた（2022年2月8日更新）

先日投稿した「テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Twenty One」でWebフォントを使うことができた。その後、ほかのテーマで試したところ、そのままではWebフォントを使うことができなかった。今回は、それらのテーマの対応について紹介する。

ブロックエディターで現在の「ロケール」を取得した時のメモ（2024年8月10日更新）

ブロックエディター向けのプラグインで日本語固有の機能を実装する際、現在のロケール（言語）を取得したい。ブロックエディターの編集時、投稿を編集しているユーザーの言語が優先され、それをどうやって取得するかを「ChatGPT」に聞いてみたのだが。。。

スマートフォン向けの振り分けを自前で行う（2012年1月23日更新）

PC向けのサイトをスマートフォン対応する場合、WPtouchやktai styleに代表されるスマートフォン対応のテンプレート切り替えプラグインを使用するのが一般的。そういったプラグインはテンプレート切り替え以外の機能も備えており、そういった機能は必ずしも必要ではない。そんなわけで、ここでは超シンプルなスマートフォン向けのテンプレート切り替えを実現する方法を紹介する。

説明