wp_mail

函数


      wp_mail ( $to, $subject, $message, $headers = '', $attachments = array() )

参数

(string|string[]) $to Array or comma-separated list of email addresses to send message.

Required: 是
(string) $subject Email subject.

Required: 是
(string) $message Message contents.

Required: 是
(string|string[]) $headers Optional. Additional headers.

Required: 否

Default: (empty)
(string|string[]) $attachments Optional. Paths to files to attach.

Required: 否

Default: array()

返回值

(bool) Whether the email was sent successfully.

定义位置

wp-includes/pluggable.php , line 174

相关方法: wp_meta wp_salt is_email wp_title wp_is_mobile

引入: 1.2.1

弃用: -

wp_mail: 这是WordPress中的一个函数，它允许开发者使用内置的PHP mail函数或自定义的电子邮件提供商来发送电子邮件信息: 该函数接受各种参数，如收件人的电子邮件地址、主题、信息内容和额外的标题。

发送一封电子邮件，类似于PHP的mail函数。

一个真实的返回值并不自动意味着用户成功地收到了该邮件。它只是意味着所使用的方法能够在没有任何错误的情况下处理该请求。

默认的内容类型是`text/plain`，不允许使用HTML。然而，你可以通过以下方式来设置邮件的内容类型
{@see ‘wp_mail_content_type’}过滤器来设置邮件内容类型。

默认的字符集是基于博客上使用的字符集。可以使用{@see ‘wp_mail_charset’}过滤器来设置字符集。

function wp_mail( $to, $subject, $message, $headers = '', $attachments = array() ) {
		// Compact the input, apply the filters, and extract them back out.

		/**
		 * Filters the wp_mail() arguments.
		 *
		 * @since 2.2.0
		 *
		 * @param array $args {
		 *     Array of the `wp_mail()` arguments.
		 *
		 *     @type string|string[] $to          Array or comma-separated list of email addresses to send message.
		 *     @type string          $subject     Email subject.
		 *     @type string          $message     Message contents.
		 *     @type string|string[] $headers     Additional headers.
		 *     @type string|string[] $attachments Paths to files to attach.
		 * }
		 */
		$atts = apply_filters( 'wp_mail', compact( 'to', 'subject', 'message', 'headers', 'attachments' ) );

		/**
		 * Filters whether to preempt sending an email.
		 *
		 * Returning a non-null value will short-circuit {@see wp_mail()}, returning
		 * that value instead. A boolean return value should be used to indicate whether
		 * the email was successfully sent.
		 *
		 * @since 5.7.0
		 *
		 * @param null|bool $return Short-circuit return value.
		 * @param array     $atts {
		 *     Array of the `wp_mail()` arguments.
		 *
		 *     @type string|string[] $to          Array or comma-separated list of email addresses to send message.
		 *     @type string          $subject     Email subject.
		 *     @type string          $message     Message contents.
		 *     @type string|string[] $headers     Additional headers.
		 *     @type string|string[] $attachments Paths to files to attach.
		 * }
		 */
		$pre_wp_mail = apply_filters( 'pre_wp_mail', null, $atts );

		if ( null !== $pre_wp_mail ) {
			return $pre_wp_mail;
		}

		if ( isset( $atts['to'] ) ) {
			$to = $atts['to'];
		}

		if ( ! is_array( $to ) ) {
			$to = explode( ',', $to );
		}

		if ( isset( $atts['subject'] ) ) {
			$subject = $atts['subject'];
		}

		if ( isset( $atts['message'] ) ) {
			$message = $atts['message'];
		}

		if ( isset( $atts['headers'] ) ) {
			$headers = $atts['headers'];
		}

		if ( isset( $atts['attachments'] ) ) {
			$attachments = $atts['attachments'];
		}

		if ( ! is_array( $attachments ) ) {
			$attachments = explode( "n", str_replace( "rn", "n", $attachments ) );
		}
		global $phpmailer;

		// (Re)create it, if it's gone missing.
		if ( ! ( $phpmailer instanceof PHPMailerPHPMailerPHPMailer ) ) {
			require_once ABSPATH . WPINC . '/PHPMailer/PHPMailer.php';
			require_once ABSPATH . WPINC . '/PHPMailer/SMTP.php';
			require_once ABSPATH . WPINC . '/PHPMailer/Exception.php';
			$phpmailer = new PHPMailerPHPMailerPHPMailer( true );

			$phpmailer::$validator = static function ( $email ) {
				return (bool) is_email( $email );
			};
		}

		// Headers.
		$cc       = array();
		$bcc      = array();
		$reply_to = array();

		if ( empty( $headers ) ) {
			$headers = array();
		} else {
			if ( ! is_array( $headers ) ) {
				// Explode the headers out, so this function can take
				// both string headers and an array of headers.
				$tempheaders = explode( "n", str_replace( "rn", "n", $headers ) );
			} else {
				$tempheaders = $headers;
			}
			$headers = array();

			// If it's actually got contents.
			if ( ! empty( $tempheaders ) ) {
				// Iterate through the raw headers.
				foreach ( (array) $tempheaders as $header ) {
					if ( strpos( $header, ':' ) === false ) {
						if ( false !== stripos( $header, 'boundary=' ) ) {
							$parts    = preg_split( '/boundary=/i', trim( $header ) );
							$boundary = trim( str_replace( array( "'", '"' ), '', $parts[1] ) );
						}
						continue;
					}
					// Explode them out.
					list( $name, $content ) = explode( ':', trim( $header ), 2 );

					// Cleanup crew.
					$name    = trim( $name );
					$content = trim( $content );

					switch ( strtolower( $name ) ) {
						// Mainly for legacy -- process a "From:" header if it's there.
						case 'from':
							$bracket_pos = strpos( $content, '<' );
							if ( false !== $bracket_pos ) {
								// Text before the bracketed email is the "From" name.
								if ( $bracket_pos > 0 ) {
									$from_name = substr( $content, 0, $bracket_pos );
									$from_name = str_replace( '"', '', $from_name );
									$from_name = trim( $from_name );
								}

								$from_email = substr( $content, $bracket_pos + 1 );
								$from_email = str_replace( '>', '', $from_email );
								$from_email = trim( $from_email );

								// Avoid setting an empty $from_email.
							} elseif ( '' !== trim( $content ) ) {
								$from_email = trim( $content );
							}
							break;
						case 'content-type':
							if ( strpos( $content, ';' ) !== false ) {
								list( $type, $charset_content ) = explode( ';', $content );
								$content_type                   = trim( $type );
								if ( false !== stripos( $charset_content, 'charset=' ) ) {
									$charset = trim( str_replace( array( 'charset=', '"' ), '', $charset_content ) );
								} elseif ( false !== stripos( $charset_content, 'boundary=' ) ) {
									$boundary = trim( str_replace( array( 'BOUNDARY=', 'boundary=', '"' ), '', $charset_content ) );
									$charset  = '';
								}

								// Avoid setting an empty $content_type.
							} elseif ( '' !== trim( $content ) ) {
								$content_type = trim( $content );
							}
							break;
						case 'cc':
							$cc = array_merge( (array) $cc, explode( ',', $content ) );
							break;
						case 'bcc':
							$bcc = array_merge( (array) $bcc, explode( ',', $content ) );
							break;
						case 'reply-to':
							$reply_to = array_merge( (array) $reply_to, explode( ',', $content ) );
							break;
						default:
							// Add it to our grand headers array.
							$headers[ trim( $name ) ] = trim( $content );
							break;
					}
				}
			}
		}

		// Empty out the values that may be set.
		$phpmailer->clearAllRecipients();
		$phpmailer->clearAttachments();
		$phpmailer->clearCustomHeaders();
		$phpmailer->clearReplyTos();
		$phpmailer->Body    = '';
		$phpmailer->AltBody = '';

		// Set "From" name and email.

		// If we don't have a name from the input headers.
		if ( ! isset( $from_name ) ) {
			$from_name = 'WordPress';
		}

		/*
		 * If we don't have an email from the input headers, default to wordpress@$sitename
		 * Some hosts will block outgoing mail from this address if it doesn't exist,
		 * but there's no easy alternative. Defaulting to admin_email might appear to be
		 * another option, but some hosts may refuse to relay mail from an unknown domain.
		 * See https://core.trac.wordpress.org/ticket/5007.
		 */
		if ( ! isset( $from_email ) ) {
			// Get the site domain and get rid of www.
			$sitename   = wp_parse_url( network_home_url(), PHP_URL_HOST );
			$from_email = 'wordpress@';

			if ( null !== $sitename ) {
				if ( 'www.' === substr( $sitename, 0, 4 ) ) {
					$sitename = substr( $sitename, 4 );
				}

				$from_email .= $sitename;
			}
		}

		/**
		 * Filters the email address to send from.
		 *
		 * @since 2.2.0
		 *
		 * @param string $from_email Email address to send from.
		 */
		$from_email = apply_filters( 'wp_mail_from', $from_email );

		/**
		 * Filters the name to associate with the "from" email address.
		 *
		 * @since 2.3.0
		 *
		 * @param string $from_name Name associated with the "from" email address.
		 */
		$from_name = apply_filters( 'wp_mail_from_name', $from_name );

		try {
			$phpmailer->setFrom( $from_email, $from_name, false );
		} catch ( PHPMailerPHPMailerException $e ) {
			$mail_error_data                             = compact( 'to', 'subject', 'message', 'headers', 'attachments' );
			$mail_error_data['phpmailer_exception_code'] = $e->getCode();

			/** This filter is documented in wp-includes/pluggable.php */
			do_action( 'wp_mail_failed', new WP_Error( 'wp_mail_failed', $e->getMessage(), $mail_error_data ) );

			return false;
		}

		// Set mail's subject and body.
		$phpmailer->Subject = $subject;
		$phpmailer->Body    = $message;

		// Set destination addresses, using appropriate methods for handling addresses.
		$address_headers = compact( 'to', 'cc', 'bcc', 'reply_to' );

		foreach ( $address_headers as $address_header => $addresses ) {
			if ( empty( $addresses ) ) {
				continue;
			}

			foreach ( (array) $addresses as $address ) {
				try {
					// Break $recipient into name and address parts if in the format "Foo <bar@baz.com>".
					$recipient_name = '';

					if ( preg_match( '/(.*)<(.+)>/', $address, $matches ) ) {
						if ( count( $matches ) == 3 ) {
							$recipient_name = $matches[1];
							$address        = $matches[2];
						}
					}

					switch ( $address_header ) {
						case 'to':
							$phpmailer->addAddress( $address, $recipient_name );
							break;
						case 'cc':
							$phpmailer->addCc( $address, $recipient_name );
							break;
						case 'bcc':
							$phpmailer->addBcc( $address, $recipient_name );
							break;
						case 'reply_to':
							$phpmailer->addReplyTo( $address, $recipient_name );
							break;
					}
				} catch ( PHPMailerPHPMailerException $e ) {
					continue;
				}
			}
		}

		// Set to use PHP's mail().
		$phpmailer->isMail();

		// Set Content-Type and charset.

		// If we don't have a content-type from the input headers.
		if ( ! isset( $content_type ) ) {
			$content_type = 'text/plain';
		}

		/**
		 * Filters the wp_mail() content type.
		 *
		 * @since 2.3.0
		 *
		 * @param string $content_type Default wp_mail() content type.
		 */
		$content_type = apply_filters( 'wp_mail_content_type', $content_type );

		$phpmailer->ContentType = $content_type;

		// Set whether it's plaintext, depending on $content_type.
		if ( 'text/html' === $content_type ) {
			$phpmailer->isHTML( true );
		}

		// If we don't have a charset from the input headers.
		if ( ! isset( $charset ) ) {
			$charset = get_bloginfo( 'charset' );
		}

		/**
		 * Filters the default wp_mail() charset.
		 *
		 * @since 2.3.0
		 *
		 * @param string $charset Default email charset.
		 */
		$phpmailer->CharSet = apply_filters( 'wp_mail_charset', $charset );

		// Set custom headers.
		if ( ! empty( $headers ) ) {
			foreach ( (array) $headers as $name => $content ) {
				// Only add custom headers not added automatically by PHPMailer.
				if ( ! in_array( $name, array( 'MIME-Version', 'X-Mailer' ), true ) ) {
					try {
						$phpmailer->addCustomHeader( sprintf( '%1$s: %2$s', $name, $content ) );
					} catch ( PHPMailerPHPMailerException $e ) {
						continue;
					}
				}
			}

			if ( false !== stripos( $content_type, 'multipart' ) && ! empty( $boundary ) ) {
				$phpmailer->addCustomHeader( sprintf( 'Content-Type: %s; boundary="%s"', $content_type, $boundary ) );
			}
		}

		if ( ! empty( $attachments ) ) {
			foreach ( $attachments as $attachment ) {
				try {
					$phpmailer->addAttachment( $attachment );
				} catch ( PHPMailerPHPMailerException $e ) {
					continue;
				}
			}
		}

		/**
		 * Fires after PHPMailer is initialized.
		 *
		 * @since 2.2.0
		 *
		 * @param PHPMailer $phpmailer The PHPMailer instance (passed by reference).
		 */
		do_action_ref_array( 'phpmailer_init', array( &$phpmailer ) );

		$mail_data = compact( 'to', 'subject', 'message', 'headers', 'attachments' );

		// Send!
		try {
			$send = $phpmailer->send();

			/**
			 * Fires after PHPMailer has successfully sent an email.
			 *
			 * The firing of this action does not necessarily mean that the recipient(s) received the
			 * email successfully. It only means that the `send` method above was able to
			 * process the request without any errors.
			 *
			 * @since 5.9.0
			 *
			 * @param array $mail_data {
			 *     An array containing the email recipient(s), subject, message, headers, and attachments.
			 *
			 *     @type string[] $to          Email addresses to send message.
			 *     @type string   $subject     Email subject.
			 *     @type string   $message     Message contents.
			 *     @type string[] $headers     Additional headers.
			 *     @type string[] $attachments Paths to files to attach.
			 * }
			 */
			do_action( 'wp_mail_succeeded', $mail_data );

			return $send;
		} catch ( PHPMailerPHPMailerException $e ) {
			$mail_data['phpmailer_exception_code'] = $e->getCode();

			/**
			 * Fires after a PHPMailerPHPMailerException is caught.
			 *
			 * @since 4.4.0
			 *
			 * @param WP_Error $error A WP_Error object with the PHPMailerPHPMailerException message, and an array
			 *                        containing the mail recipient, subject, message, headers, and attachments.
			 */
			do_action( 'wp_mail_failed', new WP_Error( 'wp_mail_failed', $e->getMessage(), $mail_data ) );

			return false;
		}
	}
endif;

if ( ! function_exists( 'wp_authenticate' ) ) :
	/**
	 * Authenticates a user, confirming the login credentials are valid.
	 *
	 * @since 2.5.0
	 * @since 4.5.0 `$username` now accepts an email address.
	 *
	 * @param string $username User's username or email address.
	 * @param string $password User's password.
	 * @return WP_User|WP_Error WP_User object if the credentials are valid,
	 *                          otherwise WP_Error.
	 */

常见问题

FAQs

如何使用get_users获取所有用户列表？
要使用` get_users `函数获取所有用户列表，可以按照以下步骤进行：

1. 使用` get_users `函数调用获取用户列表：
```
$users = get_users();
```
2. 您可以按需使用参数来过滤结果。例如，您可以通过角色、用户ID、用户登录名等过滤用户列表。以下是一个根据用户角色为过滤条件的示例：
```
$users = get_users( array(
    'role' => 'subscriber' // 将角色名称替换为您要过滤的角色
) );
```
在上述示例中，将` role `参数设置为所需的角色名称来过滤用户列表。

3. 您可以使用循环遍历获取的用户列表，并访问每个用户的属性。例如，以下示例将显示每个用户的用户名和电子邮件地址：
```
foreach( $users as $user ) {
    echo '用户名：' . $user->user_login . ', 电子邮件：' . $user->user_email . ;
}
```
在上述示例中，通过` $user->user_login `和` $user->user_email `访问每个用户的用户名和电子邮件地址。

请注意，` get_users `函数默认返回所有用户，并可以根据需要使用更多参数进行过滤。您可以参阅WordPress官方文档中的` get_users `函数文档，了解更多可用参数和用法示例。

总结起来，使用` get_users `函数获取所有用户列表的步骤是：
1. 调用` get_users `函数获取用户列表。
2. 使用可选的过滤参数，根据需要过滤用户列表。
3. 使用循环遍历用户列表，并访问每个用户的属性。
如何使用WP_PLUGIN_DIR和WP_PLUGIN_URL定义插件的目录和URL？
在WordPress中，可以使用WP_PLUGIN_DIR和WP_PLUGIN_URL常量来定义插件的目录路径和URL。

1. `WP_PLUGIN_DIR`：这是一个常量，用于定义插件的目录路径（文件系统路径）。您可以使用以下代码在插件文件中访问该常量：
```
$plugin_dir = WP_PLUGIN_DIR . '/your-plugin-folder/';
```
在上述代码中，将"your-plugin-folder"替换为您插件的实际文件夹名称。使用该常量，您可以获取插件文件的完整路径。

2. `WP_PLUGIN_URL`：这是一个常量，用于定义插件的URL（用于在网页上访问插件文件）。以下是一个使用该常量的示例：
```
$plugin_url = WP_PLUGIN_URL . '/your-plugin-folder/';
```
同样，请将"your-plugin-folder"替换为您插件的实际文件夹名称。使用该常量，您可以获取插件在网页上的完整URL。

请注意，`WP_PLUGIN_DIR`和`WP_PLUGIN_URL`常量在WordPress版本2.6之后引入。从WordPress 5.5版本开始，这两个常量被标记为过时（deprecated），因为WordPress更倾向于使用新的插件文件结构。如果您正在开发新插件，建议使用新的插件文件结构和相关函数。

在新的插件文件结构中，可以使用以下函数来获取插件的目录路径和URL：

- `plugin_dir_path()`：获取插件目录路径。
- `plugin_dir_url()`：获取插件URL。

这些函数会自动将插件的版本、多站点和SSL等考虑因素纳入计算。

总结起来，使用`WP_PLUGIN_DIR`和`WP_PLUGIN_URL`常量定义插件的目录和URL的方法是：
```
$plugin_dir = WP_PLUGIN_DIR . '/your-plugin-folder/';
$plugin_url = WP_PLUGIN_URL . '/your-plugin-folder/';
```
但请注意，这两个常量已被标记为过时，建议使用新的插件文件结构和相关函数来获取插件的路径和URL。
如何使用PHP在WordPress中添加自定义功能？
使用PHP在WordPress中添加自定义功能可以通过以下方式实现：
- 创建一个自定义插件，将功能代码添加到插件中。
- 使用WordPress的钩子系统，将自定义功能绑定到适当的钩子上。
- 在主题文件中添加自定义功能代码，例如functions.php文件。
- 使用WordPress的短代码功能，将自定义功能封装为短代码。
- 使用WordPress的插件或主题编辑器，将自定义功能代码添加到适当的位置。
下面是一个实操示例。

要在WordPress中添加自定义功能，可以按照以下步骤使用PHP编写并添加自定义功能：
1. 打开WordPress安装目录中的主题文件夹，通常位于wp-content/themes/下，找到正在使用的主题文件夹。
2. 在主题文件夹中，可以创建一个名为functions.php的文件。如果该文件已经存在，可以直接编辑它。
3. 在functions.php文件中，可以使用PHP代码添加自定义功能。以下是一些常见的示例：
```
// 添加自定义功能示例

// 1. 创建自定义短代码
function custom_shortcode() {
    return '这是我的自定义短代码内容';
}
add_shortcode('custom', 'custom_shortcode');

// 2. 自定义小工具
function custom_widget() {
    echo '这是我的自定义小工具内容';
}
register_widget('custom_widget');

// 3. 自定义菜单
function custom_menu() {
    register_nav_menu('custom-menu', '自定义菜单');
}
add_action('after_setup_theme', 'custom_menu');

// 4. 自定义页面模板
function custom_page_template() {
    /* Template Name: 自定义模板 */
    // 自定义模板的内容和样式
}
```
4. 编辑完functions.php文件后，保存并上传到WordPress主题文件夹中。
请注意，修改主题文件可以在主题更新时丢失，因此建议在进行任何更改之前备份functions.php文件。此外，为避免不必要的错误和冲突，建议在添加自定义功能前先了解WordPress开发文档和最佳实践，以确保正确、安全地实现所需的自定义功能。
如何进行WordPress数据库查询优化？
进行WordPress数据库查询优化可以通过以下方式实现：
- 使用WordPress提供的内置查询函数，例如 WP_Query 、 get_posts 等。
- 使用适当的查询参数和过滤器，减少查询次数和数据量。
- 编写自定义的数据库查询语句，使用适当的索引和缓存。
- 优化数据库服务器配置和性能。
- 定期清理和优化数据库表。
如何使用do_action来触发一个钩子函数？
使用 do_action 函数可以触发一个钩子函数。do_action 函数的参数与要触发的钩子函数的参数相同。

例如，触发save_post钩子函数的代码如下：
```
do_action( 'save_post', $post_ID, $post );
```
这里，$post_ID 和 $post 是传递给钩子函数的参数。

如何使用wp_get_current_user获取当前登录用户的信息？

使用 wp_get_current_user 获取当前登录用户的信息：

$current_user = wp_get_current_user();  
  
// 获取当前用户的ID  
$user_id = $current_user->ID;  
  
// 获取当前用户的用户名  
$user_login = $current_user->user_login;  
  
// 获取当前用户的邮箱  
$user_email = $current_user->user_email;  
  
// 获取当前用户的显示名称  
$display_name = $current_user->display_name;

wp_mail

常见问题

相关文章