wp_mail

wp_mail - メールを送信する

説明

bool wp_mail( string $to, string $subject, string $message [ , mixed $headers = '' [ , mixed $attachments = array() ] ] )
メールを送信する。

パラメータ

  • $to
    送信先メールアドレスを指定。
  • $subject
    メールタイトルを指定。
  • $message
    メール本文を指定。
  • $headers
    メールヘッダー情報を文字列または配列で指定(省略時は'')。
  • $attachments
    添付ファイルを文字列または配列で指定(省略時はarray())。

返り値

メールを送信できた場合はtrueを。送信できなかった場合はfalseを返す。

注意

パラメータ$headersで送信元('from')が省略された場合は、名前は'WordPress'、メールアドレスは'wordpress@'サイト名('www.'から始まる場合は除外される)が適用される。
パラメータ$headersでコンテント情報('content-type')が省略された場合は、content-typeが'text/plain'、charsetが'UTF-8'が適用される。

使用例

  • 送信元を省略してメールを送信する。
    <?php @wp_mail( $to, $subject, $message ); ?>
  • 送信元を指定してメールを送信する。
    <?php
    $blogname = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
    $wp_email = 'wordpress@'.preg_replace( '#^www\.#', '', strtolower( $_SERVER['SERVER_NAME'] ) );
    $headers = "From: \"{$blogname}\" <{$wp_email}>\n".
    	"Content-Type: text/plain; charset=\"UTF-8\"\n";
    @wp_mail( $to, $subject, $message, $headers );
    ?>

フィルター

本関数の冒頭で'wp_mail'フィルターを呼び出す。パラメータ$paramsは本関数で受け取った5つのパラメータを格納した連想配列となる。
extract( apply_filters( 'wp_mail', $params ) );
メールの送信者メールアドレスの確定前に'wp_mail_from'フィルターを呼び出す。パラメータは確定前のメールアドレスとなる。
$from = apply_filters( 'wp_mail_from', $from_email );
メールの送信者名の確定前に'wp_mail_from_name'フィルターを呼び出す。パラメータは確定前の送信者名となる。
$from_name = apply_filters( 'wp_mail_from_name', $from_name );
メールのcontent-typeの確定前に'wp_mail_content_type'フィルターを呼び出す。パラメータは確定前のcontent-typeとなる。
$content_type = apply_filters( 'wp_mail_content_type', $content_type );
メールのcharsetの確定前に'wp_mail_charset'フィルターを呼び出す。パラメータは確定前のcharsetとなる。
$charset = apply_filters( 'wp_mail_charset', $charset );

アクション

メールを送信する直前に'phpmailer_init'アクションを呼び出す。パラメータはPHPMailerクラスのオブジェクトが格納された配列となる。
do_action_ref_array( 'phpmailer_init', array( &$phpmailer ) );

ソースファイル

/wp-includes/pluggable.php

お勧めコンテンツ

タイトルのみをキーワード検索する(2014年4月3日 登録)

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。

4.2の「アクティビティ」ウィジェットに投稿以外の情報も表示する(2015年5月13日 登録)

ダッシュボードの「アクティビティ」ウィジェットは「投稿(post)」の状況を表示し、固定ページ(page)やカスタム投稿タイプの投稿記事の状況については標準では表示されない。このことに対して以前『3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する』を紹介したのだが、4.2では新しいフィルターが追加され、カスタマイズが少し容易になった。

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

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

「テキスト」モードと「ビジュアル」モードを行き来すると投稿内容の一部が消える(2015年3月14日 登録)

仕事がらサイトの引っ越し作業のお手伝いをすることがあるのですが、今回は引っ越しにあわせてWordPressを「3.7.1」から最新版「4.1.1」にアップデートすることになりました。ここで紹介するのはこの案件で発生したトラブルの話です。

Login rebuilderのログ表示機能を紹介(2015年7月9日 登録)

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

最終更新日時 : 2014-07-31 21:54