wp_mail

パラメータ

• $to
  送信先メールアドレスまたはその配列を指定。
• $subject
  メールタイトルを指定。
• $message
  メール本文を指定。
• $headers
  メールヘッダー情報を文字列または配列で指定（省略時は''）。
• $attachments
  添付ファイルを文字列または配列で指定（省略時はarray()）。
• $embeds
  [6.9.0]埋め込みファイルを文字列または配列で指定（省略時はarray()）。

返り値

注意

パラメータ$headersで送信元（'from'）が省略された場合は、名前は'WordPress'、メールアドレスは'wordpress@'サイト名（'www.'から始まる場合は除外される）が適用される。
パラメータ$headersでコンテント情報（'content-type'）が省略された場合は、content-typeが'text/plain'、charsetが'UTF-8'が適用される。

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

[6.9.0]パラメータ$embedsが追加され、その内容は'wp_mail'および'pre_wp_mail'フィルターのパラメータにも反映される。

[6.9.0]マルチパートメッセージに対するContent-Typeヘッダーの処理を改善した。

使用例

• 送信元を省略してメールを送信する。
  <?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 );
  ?>

フィルター

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 );

$embed_args = apply_filters(
	'wp_mail_embed_args',
	array(
		'path'        => $embed_path,
		'cid'         => (string) $key,
		'name'        => basename( $embed_path ),
		'encoding'    => 'base64',
		'type'        => '',
		'disposition' => 'inline',
	)
);

アクション

do_action_ref_array( 'phpmailer_init', array( &$phpmailer ) );

do_action( 'wp_mail_succeeded', $mail_data );

do_action( 'wp_mail_failed', $error );

ソースファイル