説明
パラメータ
- $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
関連
お勧め
edit_custom_thumbnail_sizesフィルターを使ってみた(2022年5月30日 更新)
アップロード済みの画像は、トリミングや回転、反転といった編集が可能である。6.0.0で追加されたedit_custom_thumbnail_sizesフィルターは、編集された内容を反映させるサイズを拡張するものだったので、さっそく使ってみた。
WordPressと組み込まれている主なJavaScriptライブラリのバージョン一覧(2018年5月27日 更新)
WordPressの更新が遅れていたサイトを少し前に更新したところ、jQuery UI sortableを使って拡張したページに不具合が発生しました。WordPressの更新に伴って内部のjQuery UIが更新されたことに起因すると思われ、これを機にWordPressとそれに組み込まれたJavaScriptライブラリのバージョンを確認してみました。
投稿日の検索が自由自在に(2015年3月7日 更新)
WordPress 3.7.0ではWP_Date_Queryクラスが追加され、WP_Queryクラス(もちろん query_posts関数でも)で利用できるようになった。このWP_Date_Queryにより、○年○月○日以前や以降の投稿情報を取得したり、○年○月○日から○年○月○日の範囲の投稿情報を取得したりといったことが、容易に行えるようになった。
新テーマ「Twenty Twenty-Three」にはfunctions.phpがない(2022年10月6日 更新)
WordPress 6.1に同梱された新テーマ「Twenty Twenty-Three」を見てみると、そこには見慣れたfunctions.phpがない。Full Site Editing(FSE)対応テーマってこんな感じなのかと思いつつ、テーマの設定がどうなっているのか調べてみた。
WordPressのコーディングスタンダードとPSR-2がかみ合わない(2018年5月27日 更新)
先日パソコンのストレージを換装して開発環境を再構築。エディタのEclipseは「Neon(4.6)」から「Oxygen(4.7)」へ切り替わった。コードを書き始めるとそこはかとなく違和感があり、調べていくとPHPの「Code Style(Formatter)」が「PSR-2」に設定されていることが原因だった。