user_pass_ok()
云策文档标注
概述
user_pass_ok() 是一个已弃用的 WordPress 函数,用于验证用户登录名和密码的正确性。它已被 wp_authenticate() 替代,并返回布尔值表示认证结果。
关键要点
- 函数已弃用:自 WordPress 3.5.0 起,建议使用 wp_authenticate() 替代。
- 参数:接受两个必需参数 $user_login(用户名)和 $user_pass(密码)。
- 返回值:认证成功返回 true,失败返回 false。
- 内部实现:调用 wp_authenticate() 进行认证,并通过 is_wp_error() 检查错误。
代码示例
function user_pass_ok($user_login, $user_pass) {
_deprecated_function( __FUNCTION__, '3.5.0', 'wp_authenticate()' );
$user = wp_authenticate( $user_login, $user_pass );
if ( is_wp_error( $user ) )
return false;
return true;
}注意事项
- 避免在新代码中使用此函数,因为它已被标记为弃用,可能导致兼容性问题。
- 相关函数包括 wp_authenticate()、_deprecated_function() 和 is_wp_error()。
原文内容
Check that the user login name and password is correct.
Description
See also
Parameters
$user_loginstringrequired-
User name.
$user_passstringrequired-
User password.
Source
function user_pass_ok($user_login, $user_pass) {
_deprecated_function( __FUNCTION__, '3.5.0', 'wp_authenticate()' );
$user = wp_authenticate( $user_login, $user_pass );
if ( is_wp_error( $user ) )
return false;
return true;
}
Changelog
| Version | Description |
|---|---|
| 3.5.0 | Deprecated. Use wp_authenticate() |
| 0.71 | Introduced. |