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'メールのヘッダー情報(既定値は'')

使用例

  • ユーザが登録されたことを管理者に通知する。
    <?php wp_new_user_notification( $user_id ); ?>
  • ユーザが登録されたことをユーザのみに通知する。
    <?php wp_new_user_notification( $user_id, null, '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 );
[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

最終更新 : 2018年05月27日 10:43



お勧め

WordPressと組み込まれている主なJavaScriptライブラリのバージョン一覧(2018年5月27日 更新)

WordPressの更新が遅れていたサイトを少し前に更新したところ、jQuery UI sortableを使って拡張したページに不具合が発生しました。WordPressの更新に伴って内部のjQuery UIが更新されたことに起因すると思われ、これを機にWordPressとそれに組み込まれたJavaScriptライブラリのバージョンを確認してみました。

ホームディレクトリから過去のファイルを削除する(2013年1月27日 更新)

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

検索ワード「-10,000円」を検索できるようにしたい(2018年5月27日 更新)

とあるサイトで「-10,000円」をキーワードに検索した際、予想と異なるページが表示され、ちょっと驚いた。今回はその原因調査と対策についてまとめてみた。

ダッシュボードのフィードボックスをカスタマイズ(2011年7月8日 更新)

管理者ページのトップページ「ダッシュボード」には、「WordPress 開発者ブログ」と「WordPress フォーラム」という2つのフィードボックスが表示されている。自分のような開発者には有益な情報をもたらしているが、一般の方には必要のない情報かもしれない。今回はこのフィードボックスをカスタマイズする方法を紹介する(管理者権限)。