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

お勧めコンテンツ

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

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

固定ページのURLの拡張子をhtmlに変更する(2012年8月8日 登録)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

リクエスト応答を終了する前に何かを処理する(2013年9月26日 登録)

PHPでは、register_shutdown_function関数を使うことでリクエストに対してレスポンスを返した後に何らかの処理を行うことができる。WordPressでもregister_shutdown_function関数は使えると思うのだが、テーマ内のテンプレートでページを表示した後で何かを行う場合はどうすればいいのか、ちょっと調べてみた。

query_posts(WP_Queryクラス)で'tax_query'を使いこなす(2011年9月8日 登録)

2日にわたって投稿した「query_posts(WP_Queryクラス)でカテゴリーを絞り込む」「query_posts(WP_Queryクラス)で投稿タグを絞り込む」の続き。今日はカテゴリーや投稿タグ以外ののタクソノミーによる絞り込み、複数のタクソノミーの絞り込みの組み合わせについてまとめてみる。

LevelとCapability(2011年4月14日 登録)

プラグインやテーマの管理ページを作成する際など、ユーザのレベルと権限を確認することがある。ここでは、権限グループ別のレベルと権限の有無を整理してみた。

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