函数文档

validate_email()

💡 云策文档标注

概述

validate_email() 是一个已弃用的 WordPress 函数,用于验证电子邮件地址。它已被 is_email() 替代,自 WordPress 3.0.0 起标记为弃用。

关键要点

  • validate_email() 函数已弃用,建议使用 is_email() 进行电子邮件验证。
  • 该函数接受两个参数:$email(必需,要验证的电子邮件地址)和 $check_domain(可选,默认为 true,已弃用)。
  • 返回值:成功时返回有效的电子邮件地址字符串,失败时返回 false。
  • 弃用信息通过 _deprecated_function() 标记,并提示从 WordPress 3.0.0 开始使用 is_email()。

代码示例

function validate_email( $email, $check_domain = true ) {
    _deprecated_function( __FUNCTION__, '3.0.0', 'is_email()' );
    return is_email( $email, $check_domain );
}

注意事项

在开发中应避免使用 validate_email(),转而使用 is_email() 以确保代码兼容性和遵循 WordPress 最佳实践。


📄 原文内容

Deprecated functionality to validate an email address.

Description

See also

Parameters

$emailstringrequired
Email address to verify.
$check_domainbooloptional
Deprecated.

Default:true

Return

string|false Valid email address on success, false on failure.

Source

function validate_email( $email, $check_domain = true) {
	_deprecated_function( __FUNCTION__, '3.0.0', 'is_email()' );
	return is_email( $email, $check_domain );
}

Changelog

Version Description
3.0.0 Deprecated. Use is_email()
MU (3.0.0) Introduced.