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



お勧め

oEmbed対応サイトを整理した(2020年4月6日 更新)

投稿記事にTwitterやYouTubeのURL(アドレス)を記述したとき、表示されるページにはリンクとしてではなく、埋め込んだURLの内容が表示される。この仕組み(機能)はoEmbedというもので、対応サイトは随時バージョンアップしている。

5.7の機能拡張:エクスポートファイルに更新日時が追加ほか(2021年2月23日 更新)

WordPressはサイト移行を支援する機能として投稿情報のエクスポート機能を備えている。5.7ではこのエクスポート機能が改良され、更新日時情報が追加されるようだ。

絵文字画像がPNGからSVGへ(2018年5月27日 更新)

WordPressでは絵文字に対応していないブラウザ環境で絵文字を表示する仕組みをバージョン4.2から提供。絵文字に対応しているブラウザとそん色がない表示を実現する。

投稿記事でrubyタグを使えるようにする(前編)(2012年1月25日 更新)

rubyなどのルビ関連タグはIEの独自サポートから始まり、少し前のChrome/Safariが追随して利用できるようになっている。Firefoxはいまだにサポートしていないのだが、それなりに代替表示されるので、投稿記事で使えるようにしてみた。

個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。