wp_mail()发送邮件

目录

描述

A function to send e-mail, similar to PHP's mail().

The default sender name is "WordPress" and the default sender email address is wordpress@yoursite.com. These may be changed by including a header:

Optional filters 'wp_mail_from' and 'wp_mail_from_name' are run on the sender email address and name. The return values are reassembled into a 'from' address like '"Example User" <email@address.com>' If only 'wp_mail_from' returns a value, then just the email address will be used with no name.

The default content type is 'text/plain' which does not allow using HTML. You can set the content type of the email either by using the 'wp_mail_content_type' filter ( see example below), or by including a header like "Content-type: text/html". Be careful to reset 'wp_mail_content_type' back to 'text/plain' after you send your message, though, because failing to do so could lead to unexpected problems with e-mails from WP or plugins/themes.

The default charset is based on the charset used on the blog. The charset can be set using the 'wp_mail_charset' filter.

wp_mail() 描述

用法

 <?php wp_mail$to$subject$message$headers$attachments ); ?> 

wp_mail() 用法

参数

$to

(string or array) (必填) The intended recipient(s). Multiple recipients may be specified using an array or a comma-separated string.

默认值: None

$subject

(string) (必填) The subject of the message.

默认值: None

$message

(string) (必填) Message content.

默认值: None

$headers

(string or array) (可选) Mail headers to send with the message. For the string version, each header line (beginning with From:, Cc:, etc.) is delimited with a newline ("
") (advanced)

默认值: Empty

$attachments

(string or array) (可选) Files to attach: a single filename, an array of filenames, or a newline-delimited string list of multiple filenames. (advanced)

默认值: Empty

wp_mail() 参数

示例

Basic usage example:

Add attachment and "from" header:

Sending to multiple recipients:

Switch to HTML formatted email (using wp_mail_content_type filter):

As an alternative, you can specify the Content-Type HTTP header in the $headers parameter:

Example using the array form of $headers:

wp_mail() 示例

注意

  • A true return value does not automatically mean that the user received the email successfully.
  • For this function to work, the settings SMTP and smtp_port (default: 25) need to be set in your php.ini file.
  • The function is available after the hook 'plugins_loaded'.
  • The filenames in the $attachments attribute have to be filesystem paths.

Valid Address Formats

All email addresses supplied to wp_mail() as the $to parameter must comply with RFC 2822. Some valid examples:

  • user@example.com
  • user@example.com, anotheruser@example.com
  • User <user@example.com>
  • User <user@example.com>, Another User <anotheruser@example.com>

The same applies to Cc: and Bcc: fields in $headers, but as noted in the next section, it's better to push multiple addresses into an array instead of listing them on a single line. Either address format, with or without the user name, may be used.

Using $headers To Set "From:", "Cc:" and "Bcc:" Parameters

To set the "From:" email address to something other than the WordPress default sender (see #Description above), or to add "Cc:" and/or "Bcc:" recipients, you must use the $headers argument.

$headers can be a string or an array, but it may be easiest to use in the array form. To use it, push a string onto the array, starting with "From:", "Bcc:" or "Cc:" (note the use of the ":"), followed by a valid email address.

When you are using the array form, you do not need to supply line breaks ("
"
or "
"
). Although the function can handle multiple emails per line, it may simply be easier to push each email address separately onto the $headers array. The function will figure it out and will build the proper Mime header automagically. Just don't forget that each string you push must have the header type as the first part of the string ("From:", "Cc:" or "Bcc:")

wp_mail() 注意

历史

添加于 版本: 1.2.1

wp_mail() 历史

源文件

wp_mail() 函数的代码位于 wp-includes/pluggable.php.

wp_mail() 源文件