函数文档

get_user_id_from_string()

💡 云策文档标注

概述

get_user_id_from_string() 函数用于从电子邮件地址或登录名获取数字用户ID。该函数已弃用,建议使用 get_user_by() 替代。

关键要点

  • 函数接受一个字符串参数,可以是电子邮件地址或登录名,返回对应的用户ID(整数)。
  • 如果输入是数字字符串,则直接返回该数字作为用户ID。
  • 函数内部使用 get_user_by() 进行用户查找,并标记为弃用。
  • 返回值:成功时返回用户ID,失败时返回0。

代码示例

function get_user_id_from_string( $email_or_login ) {
    _deprecated_function( __FUNCTION__, '3.6.0', 'get_user_by()' );

    if ( is_email( $email_or_login ) )
        $user = get_user_by( 'email', $email_or_login );
    elseif ( is_numeric( $email_or_login ) )
        return $email_or_login;
    else
        $user = get_user_by( 'login', $email_or_login );

    if ( $user )
        return $user->ID;
    return 0;
}

注意事项

  • 该函数自 WordPress 3.6.0 版本起已弃用,开发者应迁移到 get_user_by() 函数。
  • 相关函数包括 is_email()、get_user_by() 和 _deprecated_function()。

📄 原文内容

Get a numeric user ID from either an email address or a login.

Description

A numeric string is considered to be an existing user ID and is simply returned as such.

See also

Parameters

$email_or_loginstringrequired
Either an email address or a login.

Return

int

Source

function get_user_id_from_string( $email_or_login ) {
	_deprecated_function( __FUNCTION__, '3.6.0', 'get_user_by()' );

	if ( is_email( $email_or_login ) )
		$user = get_user_by( 'email', $email_or_login );
	elseif ( is_numeric( $email_or_login ) )
		return $email_or_login;
	else
		$user = get_user_by( 'login', $email_or_login );

	if ( $user )
		return $user->ID;
	return 0;
}

Changelog

Version Description
3.6.0 Deprecated. Use get_user_by()
MU (3.0.0) Introduced.