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



お勧め

カスタムフィールド関連関数のおさらい(2012年6月22日 更新)

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。

「順序」をtextからnumberに変更してみた(2018年5月27日 更新)

固定ページの編集画面の「投稿の属性」ウィジェットには、ページの並び替えに使用できる「順序」のinput要素がある。この「順序」のinput要素はtype属性が'text'となっており、編集の際にIMEが有効になってしまう場合がある。ページの編集頻度が多くなると、その都度IMEをオフにするのがやや面倒になってくる。

Login rebuilderのログ表示機能を紹介(2018年5月27日 更新)

プラグイン「Login rebuilder」には、バージョン1.2.0からログ情報を保存・確認する機能が備わっています。このログ情報では直近のログインページへの不正アクセスやログイン試行を確認できます。ここでは保存しているログ情報の見方について簡単に説明します。

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

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

メタボックスをクラシックエディターのみで表示する(2019年1月15日 更新)

投稿画面向けにメタボックスを使ったプラグインがあり、それがブロックエディターで意図した通りに機能しなかった。この対処方法を考える過程でエディタータイプに応じてメタボックスを出し分けできる方法が見つかったので紹介したい。