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}\" \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

最終更新 : 2017年12月08日 10:35

関連

参考

Code Reference: wp_mail

お勧め

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

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

MOファイルを作ってみた（2018年7月25日 更新）

テーマやプラグインで使用するMOファイルはWindows環境では「Poedit」アプリを使うことが多かったが、最近では「GlotPress」のようなプラグインも増えてきており、選択肢は広がっている。定期的に開発環境を見直す過程で「Poedit」から「GlotPress」に切り替えようと思ったのだが、微妙にしっくりこなかった。

headタグのmeta（generator）タグを取り除く（2018年5月27日 更新）

標準的なWordPressのテーマで出力されるHTMLには、headタグ内に次のようなmetaタグが出力されている。 
<meta name="generator" content="WordPress 3.0.5" />

さくらのVPSでKUSANAGI（2018年5月27日 更新）

請け負っていた業務が一段落したので、「さくらのVPS」で「KUSANAGI」を試してみました。推奨環境はメモリ4GBとなっているが、今回は実験的な利用なので、SSD 2GBプランでトライしました。

新「WordPress Events and News」ウィジェットが興味深い（2018年5月27日 更新）

4.8のベータ版ですぐに新機能とわかるのが管理者ダッシュボードの新「WordPress Events and News」ウィジェット。ユーザーが指定した地域近隣で開催されるイベント情報を表示してくれるウィジェットで、この中のフォームがちょっと興味深かった。なおこの記事はWordPress 4.8 beta-2をもとにしており、以降のバージョンで変更される可能性があることをあらかじめ断っておく。