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'が適用される。

[5.7.0]'pre_wp_mail'フィルターの返り値がnull以外の場合、メールは送信されず、その値が本関数の返り値となる。


使用例

  • 送信元を省略してメールを送信する。
    <?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}\" \n".
    	"Content-Type: text/plain; charset=\"UTF-8\"\n";
    @wp_mail( $to, $subject, $message, $headers );
    ?>

フィルター

[2.2.0]本関数の冒頭で'wp_mail'フィルターを呼び出す。パラメータ$paramsは本関数で受け取った5つのパラメータを格納した連想配列となる。
extract( apply_filters( 'wp_mail', $params ) );
$atts = apply_filters( 'wp_mail', compact( 'to', 'subject', 'message', 'headers', 'attachments' ) );
[5.7.0]'wp_mail'フィルターの直後に'pre_wp_mail'フィルターを呼び出す。パラメータ$returnにはnullが、$attsには'wp_mail'フィルターの返り値が格納される。
$pre_wp_mail = apply_filters( 'pre_wp_mail', $return, $atts );
[2.2.0]メールの送信者メールアドレスの確定前に'wp_mail_from'フィルターを呼び出す。パラメータは確定前のメールアドレスとなる。
$from = apply_filters( 'wp_mail_from', $from_email );
[2.3.0]メールの送信者名の確定前に'wp_mail_from_name'フィルターを呼び出す。パラメータは確定前の送信者名となる。
$from_name = apply_filters( 'wp_mail_from_name', $from_name );
[2.3.0]メールのcontent-typeの確定前に'wp_mail_content_type'フィルターを呼び出す。パラメータは確定前のcontent-typeとなる。
$content_type = apply_filters( 'wp_mail_content_type', $content_type );
[2.3.0]メールのcharsetの確定前に'wp_mail_charset'フィルターを呼び出す。パラメータは確定前のcharsetとなる。
$charset = apply_filters( 'wp_mail_charset', $charset );

アクション

[2.2.0]メールを送信する直前に'phpmailer_init'アクションを呼び出す。パラメータはPHPMailerクラスのオブジェクトが格納された配列となる。
do_action_ref_array( 'phpmailer_init', array( &$phpmailer ) );
[5.9.0]メール送信できた場合に'wp_mail_succeeded'アクションを呼び出す。パラメータ$mail_dataには送信内容を示す連想配列が格納されている。
do_action( 'wp_mail_succeeded', $mail_data );
[4.4.0]メール送信が失敗した場合に'wp_mail_failed'アクションを呼び出す。パラメータ$errorにはWP_Errorオブジェクト(エラー内容と送信内容)が格納されている。
do_action( 'wp_mail_failed', $error );

ソースファイル

/wp-includes/pluggable.php

最終更新 : 2022年02月01日 10:52



お勧め

投稿一覧に独自リンクを追加する(2013年10月16日 更新)

管理者ページの「投稿一覧」や「固定ページ一覧」の各投稿記事はマウスポインタを移動すると、「編集」や「クイック編集」といったリンクが表示される。このリンクに独自のリンクを追加する方法を調べてみた。

更新ボタンの横にスピナーを実装する(2019年5月14日 更新)

WordPressの管理画面ではAJAXを使って何らかの処理を行う際、数秒間の空き時間にアイコンがクルクル回る「スピナー」を表示しているところがある。今作っているプラグインでこの「スピナー」を使いたくなったので、実装方法を調べてみた。

ブロックエディターをちょっとだけカスタマイズしてみる(2021年11月3日 更新)

ブロックエディターで投稿を編集していると「ここは〇〇だったらいいのにな」と思うところがある。今回は、そんな気になるところをいくつか(自分好みに)調整してみた。

Login rebuilder 2.3.0の新機能を紹介(2018年5月27日 更新)

プラグイン「Login rebuilder」はログイン時の履歴(ログ)や不正なログインページへのアクセス履歴を保存している。これらの履歴情報はダッシュボートで確認できるが、バージョン2.3.0においてそれぞれがダウンロードできるようになった。

メディア(attachment)を拡張してより便利に活用する(2014年5月22日 更新)

「メディア(attachment)」は、標準ではカテゴリもタグもカスタムフィールドもない。投稿と親子関係を作って利用することが前提だからともいえるが、メディアをもっと便利に活用するために、それらの付加情報を絞り込みの材料として利用できないか調べてみた。