説明
パラメータ
- $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' ) );
$pre_wp_mail = apply_filters( 'pre_wp_mail', $return, $atts );
$from = apply_filters( 'wp_mail_from', $from_email );
$from_name = apply_filters( 'wp_mail_from_name', $from_name );
$content_type = apply_filters( 'wp_mail_content_type', $content_type );
$charset = apply_filters( 'wp_mail_charset', $charset );
アクション
[2.2.0]メールを送信する直前に'phpmailer_init'アクションを呼び出す。パラメータはPHPMailerクラスのオブジェクトが格納された配列となる。do_action_ref_array( 'phpmailer_init', array( &$phpmailer ) );
do_action( 'wp_mail_succeeded', $mail_data );
do_action( 'wp_mail_failed', $error );
ソースファイル
/wp-includes/pluggable.php最終更新 : 2022年02月01日 10:52
関連
お勧め
ブロックエディターの文字サイズ設定を変えてみる(2019年12月12日 更新)
今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。
the_date関数で投稿日を確実に表示する(2011年12月20日 更新)
投稿記事の投稿日時を表示する際、 the_date関数を使用することが多いだろう。このthe_date関数はphpのdate関数と同じパラメータを指定することで、好みの日時フォーマットで投稿日時を表示できるのだが、ある条件の場合に投稿日時を表示しない。最初にこの現象に遭遇したときは、ちょっと悩まされた。投稿内容に応じてwpautopを制御する(2013年8月13日 更新)
投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。
xmlrpc.phpへのアクセスについてちょっと考えた(2018年5月27日 更新)
少し前のことですが、こちらのサーバーを何度かダウンさせてしまったのですが、その原因はxmlrpc.phpへアクセスが集中したことによってサーバーが過負荷となってしまったというものでした。すぐにサーバー性能を上げることはできないため、xmlrpc.phpのアクセスを全部拒否するという暫定対応してしまいました。
メディアライブラリに絞り込み用の「投稿タグ」を追加する(2014年6月24日 更新)
この記事は、先月投稿したコラム「メディア(attachment)を拡張してより便利に活用する」の続編。メディアで「投稿タグ」を追加するだけで「メディアライブラリ」ページの投稿一覧の中には「タグ」カラムが追加されるが、今回はその「投稿タグ」で絞り込み検索に対応してみる。