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

使用例

  • ユーザが登録されたことを管理者に通知する。
    <?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

関連

お勧めコンテンツ

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう(2011年12月8日 登録)

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

一定時間でログアウトする(2013年5月23日 登録)

ログイン関係を調べている関係で、wp_set_auth_cookie関数に行き着く。ログイン画面の「ログイン状態を保持する」がチェックされた場合、クッキーの有効期限は14日間。チェックされていない場合は、ブラウザが閉じるまで常に有効となっているんだね。

WP_List_Tableクラスの「一括操作」フォームを使ってみた(2017年9月26日 登録)

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。

開発環境(Windows 8)にimagickを入れる(2012年12月23日 登録)

WordPress 3.5のイメージエディタ(WP_Image_Editor)は、GDだけでなく、imagick(ImageMagick)にも対応している。そんなわけでWindows 8の開発環境にimagickをインストールしてみた。

add_actionを使って管理ページで独自cssを使う(2011年2月25日 登録)

テーマやプラグインで専用の管理ページを作る場合、そのページ向けのcssやjavascriptが必要になることがある。どちらもページ内に直接記述できるが、特にcssは別ファイルに分けたいほうが便利だ。ここではその方法を紹介しよう。

最終更新日時 : 2017-12-08 10:35