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



お勧め

テキストエディタの文字を変更する(2018年5月27日 更新)

テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。

query_posts(WP_Queryクラス)でカスタムフィールドを使う(2011年9月15日 更新)

先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。

更新ボタンの横にスピナーを実装する(2019年5月14日 更新)

WordPressの管理画面ではAJAXを使って何らかの処理を行う際、数秒間の空き時間にアイコンがクルクル回る「スピナー」を表示しているところがある。今作っているプラグインでこの「スピナー」を使いたくなったので、実装方法を調べてみた。

公式ディレクトリに登録するならajax.googleapis.comのライブラリは利用しない(2018年5月27日 更新)

数日前、投稿一覧ページの絞り込みドロップダウンメニューを複数選択可能にするプラグイン「Posts filter multiselect」を公開したのですが、その際に指摘されたポイントを紹介します。

Login rebuilder 2.3.0の新機能を紹介(2018年5月27日 更新)

プラグイン「Login rebuilder」はログイン時の履歴(ログ)や不正なログインページへのアクセス履歴を保存している。これらの履歴情報はダッシュボートで確認できるが、バージョン2.3.0においてそれぞれがダウンロードできるようになった。