wp_mail:WordPress私的マニュアル

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

参考

Code Reference: wp_mail

wp_mail

説明

パラメータ

返り値

注意

使用例

フィルター

アクション

ソースファイル

参考

お勧めコンテンツ